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

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

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

Overview

Note:

When making an API call, you may pass DescribeAlarmHistoryInput data as a hash:

{
  alarm_name: "AlarmName",
  history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
  start_date: Time.now,
  end_date: Time.now,
  max_records: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm.

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end

#end_dateTime

The ending date to retrieve alarm history.

Returns:

  • (Time)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end

#history_item_typeString

The type of alarm histories to retrieve.

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end

#max_recordsInteger

The maximum number of alarm history records to retrieve.

Returns:

  • (Integer)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end

#start_dateTime

The starting date to retrieve alarm history.

Returns:

  • (Time)


221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 221

class DescribeAlarmHistoryInput < Struct.new(
  :alarm_name,
  :history_item_type,
  :start_date,
  :end_date,
  :max_records,
  :next_token)
  include Aws::Structure
end