You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::DescribeAlarmHistoryInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeAlarmHistoryInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  alarm_name: "AlarmName",
  alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
  history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
  start_date: Time.now,
  end_date: Time.now,
  max_records: 1,
  next_token: "NextToken",
  scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
}

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm.

Returns:

  • (String)

    The name of the alarm.

#alarm_typesArray<String>

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

Returns:

  • (Array<String>)

    Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.

#end_dateTime

The ending date to retrieve alarm history.

Returns:

  • (Time)

    The ending date to retrieve alarm history.

#history_item_typeString

The type of alarm histories to retrieve.

Possible values:

  • ConfigurationUpdate
  • StateUpdate
  • Action

Returns:

  • (String)

    The type of alarm histories to retrieve.

#max_recordsInteger

The maximum number of alarm history records to retrieve.

Returns:

  • (Integer)

    The maximum number of alarm history records to retrieve.

#next_tokenString

The token returned by a previous call to indicate that there is more data available.

Returns:

  • (String)

    The token returned by a previous call to indicate that there is more data available.

#scan_byString

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Possible values:

  • TimestampDescending
  • TimestampAscending

Returns:

  • (String)

    Specified whether to return the newest or oldest alarm history first.

#start_dateTime

The starting date to retrieve alarm history.

Returns:

  • (Time)

    The starting date to retrieve alarm history.