:doc:`CloudWatch <../../cloudwatch>` / Waiter / CompositeAlarmExists

********************
CompositeAlarmExists
********************



.. py:class:: CloudWatch.Waiter.CompositeAlarmExists

  ::

    
    waiter = client.get_waiter('composite_alarm_exists')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`CloudWatch.Client.describe_alarms` every 5 seconds until a successful state is reached. An error is raised after 40 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms>`_    


    **Request Syntax**
    ::

      waiter.wait(
          AlarmNames=[
              'string',
          ],
          AlarmNamePrefix='string',
          AlarmTypes=[
              'CompositeAlarm'|'MetricAlarm',
          ],
          ChildrenOfAlarmName='string',
          ParentsOfAlarmName='string',
          StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
          ActionPrefix='string',
          MaxRecords=123,
          NextToken='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type AlarmNames: list
    :param AlarmNames: 

      The names of the alarms to retrieve information about.

      

    
      - *(string) --* 

      
  
    :type AlarmNamePrefix: string
    :param AlarmNamePrefix: 

      An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

       

      If this parameter is specified, you cannot specify ``AlarmNames``.

      

    
    :type AlarmTypes: list
    :param AlarmTypes: 

      Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.

       

      For example, if you omit this parameter or specify ``MetricAlarms``, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

       

      If you specify ``CompositeAlarms``, the operation returns only a list of composite alarms, and does not return any metric alarms.

      

    
      - *(string) --* 

      
  
    :type ChildrenOfAlarmName: string
    :param ChildrenOfAlarmName: 

      If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the ``AlarmRule`` field of the composite alarm that you specify in ``ChildrenOfAlarmName``. Information about the composite alarm that you name in ``ChildrenOfAlarmName`` is not returned.

       

      If you specify ``ChildrenOfAlarmName``, you cannot specify any other parameters in the request except for ``MaxRecords`` and ``NextToken``. If you do so, you receive a validation error.

       

      .. note::

        

        Only the ``Alarm Name``, ``ARN``, ``StateValue`` (OK/ALARM/INSUFFICIENT_DATA), and ``StateUpdatedTimestamp`` information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another ``DescribeAlarms`` operation and specify the parent alarm names in the ``AlarmNames`` parameter.

        

      

    
    :type ParentsOfAlarmName: string
    :param ParentsOfAlarmName: 

      If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have ``AlarmRule`` parameters that reference the alarm named in ``ParentsOfAlarmName``. Information about the alarm that you specify in ``ParentsOfAlarmName`` is not returned.

       

      If you specify ``ParentsOfAlarmName``, you cannot specify any other parameters in the request except for ``MaxRecords`` and ``NextToken``. If you do so, you receive a validation error.

       

      .. note::

        

        Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another ``DescribeAlarms`` operation and specify the parent alarm names in the ``AlarmNames`` parameter.

        

      

    
    :type StateValue: string
    :param StateValue: 

      Specify this parameter to receive information only about alarms that are currently in the state that you specify.

      

    
    :type ActionPrefix: string
    :param ActionPrefix: 

      Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of alarm descriptions to retrieve.

      

    
    :type NextToken: string
    :param NextToken: 

      The token returned by a previous call to indicate that there is more data available.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      A dictionary that provides parameters to control waiting behavior.

      

    
      - **Delay** *(integer) --* 

        The amount of time in seconds to wait between attempts. Default: 5

        

      
      - **MaxAttempts** *(integer) --* 

        The maximum number of attempts to be made. Default: 40

        

      
    
    
    :returns: None