DescribeAlarmHistory#

Description#

Returns an alarm history.

Request Parameters#

  • AlarmName — The name of the alarm.

    • Required: No

    • Type: String

    • Length constraints: from 1 to 255 symbols

  • EndDate — Ending date to retrieve alarm history.

    • Required: No

    • Type: Datetime

  • HistoryItemType — The type of alarm histories to retrieve.

    • Required: No

    • Type: String

    • Valid values: action | conf_update | state_update

  • MaxRecords — Sample size limitation.

    • Required: No

    • Type: Integer

    • Valid range: from 1 to 100

    • Default value: 20

  • NextToken — NextToken returned by a previous call (see Response Elements).

    • Required: No

    • Type: String

  • StartDate — Starting date to retrieve alarm history.

    • Required: No

    • Type: Datetime

Response Elements#

  • AlarmHistoryItem — List of alarm history items.

  • NextToken — Is returned if not all eligible alarm history items were returned because of restrictions. In order to get the next batch of data, repeat the request using the returned value as the NextToken parameter value.

    • Type: String

Examples#

c2-cw DescribeAlarmHistory

c2-cw DescribeAlarmHistory AlarmName <alarm_name> NextToken <next_token>