[ aws . cloudwatch . wait ]

alarm-exists

Description

Wait until JMESPath query length(MetricAlarms[]) > 0 returns True when polling with describe-alarms. It will poll every 5 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

alarm-exists is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: MetricAlarms, CompositeAlarms

Synopsis

  alarm-exists
[--alarm-names <value>]
[--alarm-name-prefix <value>]
[--alarm-types <value>]
[--children-of-alarm-name <value>]
[--parents-of-alarm-name <value>]
[--state-value <value>]
[--action-prefix <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--alarm-names (list)

The names of the alarms to retrieve information about.

(string)

Syntax:

"string" "string" ...

--alarm-name-prefix (string)

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 .

--alarm-types (list)

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.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  CompositeAlarm
  MetricAlarm

--children-of-alarm-name (string)

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.

--parents-of-alarm-name (string)

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.

--state-value (string)

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

Possible values:

• OK

• ALARM

• INSUFFICIENT_DATA

--action-prefix (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None