Menu
Amazon CloudWatch
Command Line Reference (API Version 2010-08-01)

mon-set-alarm-state

Description

Temporarily change the alarm state. On the next period, the alarm is set to its true state.

Syntax

mon-set-alarm-state AlarmName --state-reason value --state-value value [--state-reason-data value] [Common Options]

Options

NameDescriptionRequired

AlarmName

Specify the name of the alarm. You can also set this value using --alarm-name.

Type: Argument

Valid values: A UTF-8 string.

Default: n/a

Yes

--state-reason VALUE

Specify the reason why this alarm was set to this state (human readable).

Type: String

Valid values: A UTF-8 string between 1 and 1023 characters.

Default: n/a

Yes

--state-reason-data VALUE

Specify the reason why this alarm was set to this state. This data is intended to be machine-readable JSON.

Type: String

Valid values: A valid machine-readable JSON string between 1 and 4000 characters.

Default: n/a

No

--state-value VALUE

Specify the state the alarm should be set to.

Type: Enumeration

Valid values: ALARM, OK or INSUFFICIENT_DATA

Default: n/a

Yes

Common Options

NameDescription

--aws-credential-file VALUE

Specifies the location of the file with your AWS credentials. You can set this value by using the environment variable AWS_CREDENTIAL_FILE. If you define the environment variable or you provide the path to the credential file, the file must exist or the request will fail. All CloudWatch requests must be signed using your access key ID and secret access key.

Type: String

Valid values: A valid path to a file containing your access key ID and secret access key.

Default: Uses the environment variable AWS_CREDENTIAL_FILE, if set.

-C, --ec2-cert-file-path VALUE

Specifies the location of your EC2 certificate file for signing requests. You can use the environment variable EC2_CERT to specify this value.

Type: String

Valid values: A valid file path to the PEM file provided by Amazon EC2 or AWS Identity and Access Management.

Default: Uses the environment variable EC2_CERT, if set.

--connection-timeout VALUE

Specify a connection timeout VALUE (in seconds).

Type: Integer

Valid values: Any positive number.

Default: 30

--delimiter VALUE

What delimiter to use when displaying delimited (long) results.

Type: String

Valid values: Any string.

Default: Comma (,)

--headers

If you are displaying tabular or delimited results, it includes the column headers. If you are showing xml results, it returns the HTTP headers from the service request, if applicable.

Type: Flag

Valid values: When present, shows headers.

Default: The --headers option is off by default.

-I, --access-key-id VALUE

Specifies an access key ID of VALUE that will be used, in conjunction with the secret key, to sign the request. This must be used in conjunction with --secret-key, otherwise the option will be ignored. All requests to CloudWatch must be signed, otherwise the request will be rejected.

Type: String

Valid values: A valid access key ID.

Default: None

-K, --ec2-private-key-file-path VALUE

Specifies a private key in the file VALUE that will be used to sign the request. Using public/private keys will cause the CLI to use SOAP. The request will be signed with a public certificate and private key. This parameter must be used in conjunction with EC2_CERT, otherwise the value will be ignored. The value of the environment variable EC2_PRIVATE_KEY will be used if it is set, and this option is not specified. This option is ignored if the environment variable AWS_CREDENTIAL_FILE is set, or --aws-credentials-file is used. All requests to CloudWatch must be signed, otherwise the request will be rejected.

Type: String

Valid values: The path to a valid ASN.1 private key.

Default: None

--region VALUE

Specifies which region requests are directed to. You can use the environment variable EC2_REGION to specify the value. The region is used to create the URL used to call CloudWatch, and must be a valid Amazon Web Services (AWS) region.

Type: String

Valid values: Any AWS region, for example, us-east-1.

Default: us-east-1, unless the EC2_REGION environment variable is set.

S, --secret-key VALUE

Specify a secret key of VALUE that will be used, in conjunction with an access key ID, to sign the request. This must be used in conjunction with the --access-key-id, otherwise this option will be ignored.

Type: String

Valid values: Your access key ID.

Default: None

--show-empty-fields

Show empty fields using (nil) as a placeholder to indicate that this data was not requested.

Type: Flag

Valid values: None

Default: Empty fields are not shown by default.

--show-request

Displays the URL the CLI uses to call AWS.

Type: Flag

Valid values: None

Default: false

--show-table, --show-long, --show-xml, --quiet

Specify how the results are displayed: in a table, delimited (long), XML, or no output (quiet). The --show-table display shows a subset of the data in fixed column-width form; --show-long shows all of the returned values delimited by a character; --show-xml is the raw return from the service; and --quiet suppresses all standard output. All options are mutually exclusive, with the priority --show-table, --show-long, --show-xml, and -–quiet.

Type: Flag

Valid values: None

Default: --show-table

-U, --url VALUE

Specifies the URL used to contact CloudWatch. You can set this value using the environment variable AWS_CLOUDWATCH_URL. This value will be used in conjunction with --region to create the expected URL. This option will override the URL for the service call with VALUE.

Type: String

Valid values: A valid HTTP or HTTPS URL.

Default: Uses the value specified in AWS_CLOUDWATCH_URL, if set.

Output

This command temporarily changes an alarm's state and displays OK-Set alarm state value when the request is successful.

The Amazon CloudWatch CLI displays errors on stderr.

Examples

Example Request

This example sets the state of the alarm named my-alarm to OK.

PROMPT> mon-set-alarm-state --alarm-name my-alarm --state OK
                      
                       

Related Topics

Related Action

Related Command