AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotevents-data ]

describe-alarm

Description

Retrieves information about an alarm.

See also: AWS API Documentation

Synopsis

  describe-alarm
--alarm-model-name <value>
[--key-value <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--alarm-model-name (string)

The name of the alarm model.

--key-value (string)

The value of the key used as a filter to select only the alarms associated with the key .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

alarm -> (structure)

Contains information about an alarm.

alarmModelName -> (string)

The name of the alarm model.

alarmModelVersion -> (string)

The version of the alarm model.

keyValue -> (string)

The value of the key used as a filter to select only the alarms associated with the key .

alarmState -> (structure)

Contains information about the current state of the alarm.

stateName -> (string)

The name of the alarm state. The state name can be one of the following values:

  • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
  • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
  • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
  • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
  • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
  • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

ruleEvaluation -> (structure)

Information needed to evaluate data.

simpleRuleEvaluation -> (structure)

Information needed to compare two values with a comparison operator.

inputPropertyValue -> (string)

The value of the input property, on the left side of the comparison operator.

operator -> (string)

The comparison operator.

thresholdValue -> (string)

The threshold value, on the right side of the comparison operator.

customerAction -> (structure)

Contains information about the action that you can take to respond to the alarm.

actionName -> (string)

The name of the action. The action name can be one of the following values:

  • SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED .
  • ENABLE - When you enable the alarm, the alarm state changes to NORMAL .
  • DISABLE - When you disable the alarm, the alarm state changes to DISABLED .
  • ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED .
  • RESET - When you reset the alarm, the alarm state changes to NORMAL .

For more information, see the AlarmState API.

snoozeActionConfiguration -> (structure)

Contains the configuration information of a snooze action.

snoozeDuration -> (integer)

The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

note -> (string)

The note that you can leave when you snooze the alarm.

enableActionConfiguration -> (structure)

Contains the configuration information of an enable action.

note -> (string)

The note that you can leave when you enable the alarm.

disableActionConfiguration -> (structure)

Contains the configuration information of a disable action.

note -> (string)

The note that you can leave when you disable the alarm.

acknowledgeActionConfiguration -> (structure)

Contains the configuration information of an acknowledge action.

note -> (string)

The note that you can leave when you acknowledge the alarm.

resetActionConfiguration -> (structure)

Contains the configuration information of a reset action.

note -> (string)

The note that you can leave when you reset the alarm.

systemEvent -> (structure)

Contains information about alarm state changes.

eventType -> (string)

The event type. If the value is STATE_CHANGE , the event contains information about alarm state changes.

stateChangeConfiguration -> (structure)

Contains the configuration information of alarm state changes.

triggerType -> (string)

The trigger type. If the value is SNOOZE_TIMEOUT , the snooze duration ends and the alarm automatically changes to the NORMAL state.

severity -> (integer)

A non-negative integer that reflects the severity level of the alarm.

creationTime -> (timestamp)

The time the alarm was created, in the Unix epoch format.

lastUpdateTime -> (timestamp)

The time the alarm was last updated, in the Unix epoch format.