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
  • StartDate – Starting date to retrieve alarm history
    • Required: No
    • Type: DateTime
  • EndDate – Ending date to retrieve alarm history
    • Required: No
    • Type: DateTime
  • MaxRecords – Sample size limitation
    • Required: No
    • Type: Int
    • Valid Range: from 1 to 100
    • Default value: 20
  • HistoryItemType – The type of alarm histories to retrieve
    • Required: No
    • Type: String
    • Valid values: action | conf_update | state_update
  • NextToken – NextToken returned by a previous call (see Response Elements)
    • Required: No
    • Type: String

Response Elements

  • AlarmHistoryItem – The list of alarm history items
  • NextToken – Is returned if the alarm history items that meet the criteria were not recovered because of restrictions. In order to get next batch of data, repeat the request with returned value as NextToken parameter.
    • Type: String

Examples

c2-cw DescribeAlarmHistory

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