Amazon CloudWatch
Developer Guide (API Version 2010-08-01)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

mon-describe-alarm-history Command

Provides summary or detailed history information on the specified alarm.

SYNOPSIS
mon-describe-alarm-history
[AlarmName] [--end-date  value ] [--history-item-type  value ]
[--start-date  value ]  [General Options]

DESCRIPTION
Describe alarm history

ARGUMENTS
AlarmName
Names of the alarm.  By default history for all alarms will be returned.
You can also set this value using "--alarm-name".

SPECIFIC OPTIONS
--end-date VALUE
End of date range for history.   By default, it is current time.

--history-item-type VALUE
Type of history items you want to retrieve: one of ConfigurationUpdate,
StateUpdate or Action.  By default, all types will be returned.

--start-date VALUE
Start of date range for history.  By default it extends to all available
history.


GENERAL OPTIONS
--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.

-C, --ec2-cert-file-path VALUE
Location of your EC2 certificate file. This value can be set by using the
environment variable 'EC2_CERT'.

--connection-timeout VALUE
Specify a connection timeout VALUE (in seconds). The default value is
'30'.

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

--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. This is off by default.

-I, --access-key-id VALUE
Specify VALUE as the AWS Access Id to use.

-K, --ec2-private-key-file-path VALUE
Location of your EC2 private key file. This value can be set by using the
environment variable 'EC2_PRIVATE_KEY'.

--region VALUE
Specify region VALUE as the web service region to use. This value can be
set by using the environment variable 'EC2_REGION'.

-S, --secret-key VALUE
Specify VALUE as the AWS Secret Key to use.

--show-empty-fields
Show empty fields using "(nil)" as a placeholder to indicate that this data was
not requested. Empty fields are not shown by default.

--show-request
Displays the URL the tools used to call the AWS Service. The default
value is 'false'.

--show-table, --show-long, --show-xml, --quiet
Specify how the results are displayed: tabular, delimited (long), xml, or
no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character. The xml is the raw return from the service, while quiet
suppresses all standard output. The default is tabular, or 'show-table'.

-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable 'AWS_CLOUDWATCH_URL'.


INPUT EXAMPLES

Describe all history items for the alarm my-alm

$PROMPT> mon-describe-alarm-history --alarm-name my-alm --headers


OUTPUT
This command returns a table that contains the following:
* ALARM - Alarm name.
* TIMESTAMP - Timestamp.
* TYPE - Type of event, one of ConfigurationUpdate, StateUpdate and Action.
* SUMMARY - Human readable summary of history event.
* DATA - Detailed data on event in machine readable JSON format. This column
appears only in the --show-long view.

OUTPUT EXAMPLES

This is an example output of this command.

ALARM   TIMESTAMP                 TYPE                 SUMMARY
my-alm  2010-05-07T18:46:16.121Z  Action               Published a notification to arn:aws:sns:...
my-alm  2010-05-07T18:46:16.118Z  StateUpdate          Alarm updated from INSUFFICIENT_DATA to OK
my-alm  2010-05-07T18:46:07.362Z  ConfigurationUpdate  Alarm "my-alm" created