mon-describe-alarms - Online in the Cloud

PROGRAM:

NAME

mon-describe-alarms - Describe alarms fully.

SYNOPSIS

mon-describe-alarms
[AlarmNames [AlarmNames ...] ] [--action-prefix value ]
[--alarm-name-prefix value ] [--state-value value ] [General
Options]

DESCRIPTION

Describe alarms fully.

ARGUMENTS

AlarmNames
Names of the alarms.

SPECIFIC OPTIONS

--action-prefix VALUE
Prefix of action names.

--alarm-name-prefix VALUE
Prefix of alarm names.

--state-value VALUE
State of Alarm. One of OK, ALARM or INSUFFICIENT_DATA.

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 and rows, using a "(nil)" value. The default is
to not
show empty fields or columns.

--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 of your alarms whose name starts with my-alm

$PROMPT> mon-describe-alarms --alarm-name-prefix my-alm --headers

OUTPUT

This command returns a table that contains the following:
* ALARM - Alarm name.
* DESCRIPTION - Alarm description. This column appears only in the
--show-long view.
* STATE - Alarm state.
* STATE_REASON - Human readable reason for state. This column appears
only
in the --show-long view.
* STATE_REASON_DATA - Machine readable reason for state (JSON format).
This
column appears only in the --show-long view.
* ENABLED - Actions enabled or not. This column appears only in the
--show-long view.
* OK_ACTIONS - Action to execute on OK status. This column appears
only in
the --show-long view.
* ALARM_ACTIONS - Action to execute on ALARM status.
* INSUFFICIENT_DATA_ACTIONS - Action to execute on INSUFFICIENT_DATA
status.
This column appears only in the --show-long view.
* NAMESPACE - Namespace for metric.
* METRIC_NAME - Metric name.
* DIMENSIONS - Dimensions. This column appears only in the --show-long
view.
* PERIOD - Period.
* STATISTIC - Statistic.
* UNIT - Unit. This column appears only in the --show-long view.
* EVAL_PERIODS - Number of periods for which metric will be evaluated.
* COMPARISON - Comparison operator.
* THRESHOLD - Threshold.

OUTPUT EXAMPLES

This is an example output of this command.

Use mon-describe-alarms online using onworks.net services