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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass DescribeAlarmHistoryInput data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm.

Returns:

  • (String)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#end_dateTime

The ending date to retrieve alarm history.

Returns:

  • (Time)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#history_item_typeString

The type of alarm histories to retrieve.

Returns:

  • (String)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of alarm history records to retrieve.

Returns:

  • (Integer)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end

#start_dateTime

The starting date to retrieve alarm history.

Returns:

  • (Time)

566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/aws-sdk-cloudwatch/types.rb', line 566

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :alarm_types,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token,
  :scan_by)
  SENSITIVE = []
  include Aws::Structure
end