aws-sdk-cloudwatch 1.0.0.rc1 → 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,123 +1,121 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module CloudWatch
10
- class Resource
8
+ module Aws::CloudWatch
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
17
16
 
18
- # @return [Client]
19
- def client
20
- @client
21
- end
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
22
21
 
23
- # @!group Associations
22
+ # @!group Associations
24
23
 
25
- # @param [String] name
26
- # @return [Alarm]
27
- def alarm(name)
28
- Alarm.new(
29
- name: name,
30
- client: @client
31
- )
32
- end
24
+ # @param [String] name
25
+ # @return [Alarm]
26
+ def alarm(name)
27
+ Alarm.new(
28
+ name: name,
29
+ client: @client
30
+ )
31
+ end
33
32
 
34
- # @example Request syntax with placeholder values
35
- #
36
- # alarms = cloud_watch.alarms({
37
- # alarm_names: ["AlarmName"],
38
- # alarm_name_prefix: "AlarmNamePrefix",
39
- # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
40
- # action_prefix: "ActionPrefix",
41
- # })
42
- # @param [Hash] options ({})
43
- # @option options [Array<String>] :alarm_names
44
- # The names of the alarms.
45
- # @option options [String] :alarm_name_prefix
46
- # The alarm name prefix. You cannot specify `AlarmNames` if this
47
- # parameter is specified.
48
- # @option options [String] :state_value
49
- # The state value to be used in matching alarms.
50
- # @option options [String] :action_prefix
51
- # The action name prefix.
52
- # @return [Alarm::Collection]
53
- def alarms(options = {})
54
- batches = Enumerator.new do |y|
55
- resp = @client.describe_alarms(options)
56
- resp.each_page do |page|
57
- batch = []
58
- page.data.metric_alarms.each do |m|
59
- batch << Alarm.new(
60
- name: m.alarm_name,
61
- data: m,
62
- client: @client
63
- )
64
- end
65
- y.yield(batch)
33
+ # @example Request syntax with placeholder values
34
+ #
35
+ # alarms = cloud_watch.alarms({
36
+ # alarm_names: ["AlarmName"],
37
+ # alarm_name_prefix: "AlarmNamePrefix",
38
+ # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
39
+ # action_prefix: "ActionPrefix",
40
+ # })
41
+ # @param [Hash] options ({})
42
+ # @option options [Array<String>] :alarm_names
43
+ # The names of the alarms.
44
+ # @option options [String] :alarm_name_prefix
45
+ # The alarm name prefix. You cannot specify `AlarmNames` if this
46
+ # parameter is specified.
47
+ # @option options [String] :state_value
48
+ # The state value to be used in matching alarms.
49
+ # @option options [String] :action_prefix
50
+ # The action name prefix.
51
+ # @return [Alarm::Collection]
52
+ def alarms(options = {})
53
+ batches = Enumerator.new do |y|
54
+ resp = @client.describe_alarms(options)
55
+ resp.each_page do |page|
56
+ batch = []
57
+ page.data.metric_alarms.each do |m|
58
+ batch << Alarm.new(
59
+ name: m.alarm_name,
60
+ data: m,
61
+ client: @client
62
+ )
66
63
  end
64
+ y.yield(batch)
67
65
  end
68
- Alarm::Collection.new(batches)
69
66
  end
67
+ Alarm::Collection.new(batches)
68
+ end
70
69
 
71
- # @param [String] namespace
72
- # @param [String] name
73
- # @return [Metric]
74
- def metric(namespace, name)
75
- Metric.new(
76
- namespace: namespace,
77
- name: name,
78
- client: @client
79
- )
80
- end
70
+ # @param [String] namespace
71
+ # @param [String] name
72
+ # @return [Metric]
73
+ def metric(namespace, name)
74
+ Metric.new(
75
+ namespace: namespace,
76
+ name: name,
77
+ client: @client
78
+ )
79
+ end
81
80
 
82
- # @example Request syntax with placeholder values
83
- #
84
- # metrics = cloud_watch.metrics({
85
- # namespace: "Namespace",
86
- # metric_name: "MetricName",
87
- # dimensions: [
88
- # {
89
- # name: "DimensionName", # required
90
- # value: "DimensionValue",
91
- # },
92
- # ],
93
- # })
94
- # @param [Hash] options ({})
95
- # @option options [String] :namespace
96
- # The namespace to filter against.
97
- # @option options [String] :metric_name
98
- # The name of the metric to filter against.
99
- # @option options [Array<Types::DimensionFilter>] :dimensions
100
- # The dimensions to filter against.
101
- # @return [Metric::Collection]
102
- def metrics(options = {})
103
- batches = Enumerator.new do |y|
104
- resp = @client.list_metrics(options)
105
- resp.each_page do |page|
106
- batch = []
107
- page.data.metrics.each do |m|
108
- batch << Metric.new(
109
- namespace: m.namespace,
110
- name: m.metric_name,
111
- data: m,
112
- client: @client
113
- )
114
- end
115
- y.yield(batch)
81
+ # @example Request syntax with placeholder values
82
+ #
83
+ # metrics = cloud_watch.metrics({
84
+ # namespace: "Namespace",
85
+ # metric_name: "MetricName",
86
+ # dimensions: [
87
+ # {
88
+ # name: "DimensionName", # required
89
+ # value: "DimensionValue",
90
+ # },
91
+ # ],
92
+ # })
93
+ # @param [Hash] options ({})
94
+ # @option options [String] :namespace
95
+ # The namespace to filter against.
96
+ # @option options [String] :metric_name
97
+ # The name of the metric to filter against.
98
+ # @option options [Array<Types::DimensionFilter>] :dimensions
99
+ # The dimensions to filter against.
100
+ # @return [Metric::Collection]
101
+ def metrics(options = {})
102
+ batches = Enumerator.new do |y|
103
+ resp = @client.list_metrics(options)
104
+ resp.each_page do |page|
105
+ batch = []
106
+ page.data.metrics.each do |m|
107
+ batch << Metric.new(
108
+ namespace: m.namespace,
109
+ name: m.metric_name,
110
+ data: m,
111
+ client: @client
112
+ )
116
113
  end
114
+ y.yield(batch)
117
115
  end
118
- Metric::Collection.new(batches)
119
116
  end
120
-
117
+ Metric::Collection.new(batches)
121
118
  end
119
+
122
120
  end
123
121
  end
@@ -1,1024 +1,1162 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module CloudWatch
10
- module Types
8
+ module Aws::CloudWatch
9
+ module Types
11
10
 
12
- # Represents the history of a specific alarm.
13
- # @!attribute [rw] alarm_name
14
- # The descriptive name for the alarm.
15
- # @return [String]
16
- #
17
- # @!attribute [rw] timestamp
18
- # The time stamp for the alarm history item.
19
- # @return [Time]
20
- #
21
- # @!attribute [rw] history_item_type
22
- # The type of alarm history item.
23
- # @return [String]
24
- #
25
- # @!attribute [rw] history_summary
26
- # A summary of the alarm history, in text format.
27
- # @return [String]
28
- #
29
- # @!attribute [rw] history_data
30
- # Data about the alarm, in JSON format.
31
- # @return [String]
32
- class AlarmHistoryItem < Struct.new(
33
- :alarm_name,
34
- :timestamp,
35
- :history_item_type,
36
- :history_summary,
37
- :history_data)
38
- include Aws::Structure
39
- end
40
-
41
- # Encapsulates the statistical data that Amazon CloudWatch computes from
42
- # metric data.
43
- # @!attribute [rw] timestamp
44
- # The time stamp used for the data point.
45
- # @return [Time]
46
- #
47
- # @!attribute [rw] sample_count
48
- # The number of metric values that contributed to the aggregate value
49
- # of this data point.
50
- # @return [Float]
51
- #
52
- # @!attribute [rw] average
53
- # The average of the metric values that correspond to the data point.
54
- # @return [Float]
55
- #
56
- # @!attribute [rw] sum
57
- # The sum of the metric values for the data point.
58
- # @return [Float]
59
- #
60
- # @!attribute [rw] minimum
61
- # The minimum metric value for the data point.
62
- # @return [Float]
63
- #
64
- # @!attribute [rw] maximum
65
- # The maximum metric value for the data point.
66
- # @return [Float]
67
- #
68
- # @!attribute [rw] unit
69
- # The standard unit for the data point.
70
- # @return [String]
71
- #
72
- # @!attribute [rw] extended_statistics
73
- # The percentile statistic for the data point.
74
- # @return [Hash<String,Float>]
75
- class Datapoint < Struct.new(
76
- :timestamp,
77
- :sample_count,
78
- :average,
79
- :sum,
80
- :minimum,
81
- :maximum,
82
- :unit,
83
- :extended_statistics)
84
- include Aws::Structure
85
- end
11
+ # Represents the history of a specific alarm.
12
+ #
13
+ # @!attribute [rw] alarm_name
14
+ # The descriptive name for the alarm.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] timestamp
18
+ # The time stamp for the alarm history item.
19
+ # @return [Time]
20
+ #
21
+ # @!attribute [rw] history_item_type
22
+ # The type of alarm history item.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] history_summary
26
+ # A summary of the alarm history, in text format.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] history_data
30
+ # Data about the alarm, in JSON format.
31
+ # @return [String]
32
+ #
33
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/AlarmHistoryItem AWS API Documentation
34
+ #
35
+ class AlarmHistoryItem < Struct.new(
36
+ :alarm_name,
37
+ :timestamp,
38
+ :history_item_type,
39
+ :history_summary,
40
+ :history_data)
41
+ include Aws::Structure
42
+ end
86
43
 
87
- # @note When making an API call, pass DeleteAlarmsInput
88
- # data as a hash:
89
- #
90
- # {
91
- # alarm_names: ["AlarmName"], # required
92
- # }
93
- # @!attribute [rw] alarm_names
94
- # The alarms to be deleted.
95
- # @return [Array<String>]
96
- class DeleteAlarmsInput < Struct.new(
97
- :alarm_names)
98
- include Aws::Structure
99
- end
44
+ # Encapsulates the statistical data that Amazon CloudWatch computes from
45
+ # metric data.
46
+ #
47
+ # @!attribute [rw] timestamp
48
+ # The time stamp used for the data point.
49
+ # @return [Time]
50
+ #
51
+ # @!attribute [rw] sample_count
52
+ # The number of metric values that contributed to the aggregate value
53
+ # of this data point.
54
+ # @return [Float]
55
+ #
56
+ # @!attribute [rw] average
57
+ # The average of the metric values that correspond to the data point.
58
+ # @return [Float]
59
+ #
60
+ # @!attribute [rw] sum
61
+ # The sum of the metric values for the data point.
62
+ # @return [Float]
63
+ #
64
+ # @!attribute [rw] minimum
65
+ # The minimum metric value for the data point.
66
+ # @return [Float]
67
+ #
68
+ # @!attribute [rw] maximum
69
+ # The maximum metric value for the data point.
70
+ # @return [Float]
71
+ #
72
+ # @!attribute [rw] unit
73
+ # The standard unit for the data point.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] extended_statistics
77
+ # The percentile statistic for the data point.
78
+ # @return [Hash<String,Float>]
79
+ #
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Datapoint AWS API Documentation
81
+ #
82
+ class Datapoint < Struct.new(
83
+ :timestamp,
84
+ :sample_count,
85
+ :average,
86
+ :sum,
87
+ :minimum,
88
+ :maximum,
89
+ :unit,
90
+ :extended_statistics)
91
+ include Aws::Structure
92
+ end
100
93
 
101
- # @note When making an API call, pass DescribeAlarmHistoryInput
102
- # data as a hash:
103
- #
104
- # {
105
- # alarm_name: "AlarmName",
106
- # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
107
- # start_date: Time.now,
108
- # end_date: Time.now,
109
- # max_records: 1,
110
- # next_token: "NextToken",
111
- # }
112
- # @!attribute [rw] alarm_name
113
- # The name of the alarm.
114
- # @return [String]
115
- #
116
- # @!attribute [rw] history_item_type
117
- # The type of alarm histories to retrieve.
118
- # @return [String]
119
- #
120
- # @!attribute [rw] start_date
121
- # The starting date to retrieve alarm history.
122
- # @return [Time]
123
- #
124
- # @!attribute [rw] end_date
125
- # The ending date to retrieve alarm history.
126
- # @return [Time]
127
- #
128
- # @!attribute [rw] max_records
129
- # The maximum number of alarm history records to retrieve.
130
- # @return [Integer]
131
- #
132
- # @!attribute [rw] next_token
133
- # The token returned by a previous call to indicate that there is more
134
- # data available.
135
- # @return [String]
136
- class DescribeAlarmHistoryInput < Struct.new(
137
- :alarm_name,
138
- :history_item_type,
139
- :start_date,
140
- :end_date,
141
- :max_records,
142
- :next_token)
143
- include Aws::Structure
144
- end
94
+ # @note When making an API call, you may pass DeleteAlarmsInput
95
+ # data as a hash:
96
+ #
97
+ # {
98
+ # alarm_names: ["AlarmName"], # required
99
+ # }
100
+ #
101
+ # @!attribute [rw] alarm_names
102
+ # The alarms to be deleted.
103
+ # @return [Array<String>]
104
+ #
105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsInput AWS API Documentation
106
+ #
107
+ class DeleteAlarmsInput < Struct.new(
108
+ :alarm_names)
109
+ include Aws::Structure
110
+ end
145
111
 
146
- # @!attribute [rw] alarm_history_items
147
- # The alarm histories, in JSON format.
148
- # @return [Array<Types::AlarmHistoryItem>]
149
- #
150
- # @!attribute [rw] next_token
151
- # The token that marks the start of the next batch of returned
152
- # results.
153
- # @return [String]
154
- class DescribeAlarmHistoryOutput < Struct.new(
155
- :alarm_history_items,
156
- :next_token)
157
- include Aws::Structure
158
- end
112
+ # @note When making an API call, you may pass DescribeAlarmHistoryInput
113
+ # data as a hash:
114
+ #
115
+ # {
116
+ # alarm_name: "AlarmName",
117
+ # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
118
+ # start_date: Time.now,
119
+ # end_date: Time.now,
120
+ # max_records: 1,
121
+ # next_token: "NextToken",
122
+ # }
123
+ #
124
+ # @!attribute [rw] alarm_name
125
+ # The name of the alarm.
126
+ # @return [String]
127
+ #
128
+ # @!attribute [rw] history_item_type
129
+ # The type of alarm histories to retrieve.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] start_date
133
+ # The starting date to retrieve alarm history.
134
+ # @return [Time]
135
+ #
136
+ # @!attribute [rw] end_date
137
+ # The ending date to retrieve alarm history.
138
+ # @return [Time]
139
+ #
140
+ # @!attribute [rw] max_records
141
+ # The maximum number of alarm history records to retrieve.
142
+ # @return [Integer]
143
+ #
144
+ # @!attribute [rw] next_token
145
+ # The token returned by a previous call to indicate that there is more
146
+ # data available.
147
+ # @return [String]
148
+ #
149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryInput AWS API Documentation
150
+ #
151
+ class DescribeAlarmHistoryInput < Struct.new(
152
+ :alarm_name,
153
+ :history_item_type,
154
+ :start_date,
155
+ :end_date,
156
+ :max_records,
157
+ :next_token)
158
+ include Aws::Structure
159
+ end
159
160
 
160
- # @note When making an API call, pass DescribeAlarmsForMetricInput
161
- # data as a hash:
162
- #
163
- # {
164
- # metric_name: "MetricName", # required
165
- # namespace: "Namespace", # required
166
- # statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
167
- # extended_statistic: "ExtendedStatistic",
168
- # dimensions: [
169
- # {
170
- # name: "DimensionName", # required
171
- # value: "DimensionValue", # required
172
- # },
173
- # ],
174
- # period: 1,
175
- # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
176
- # }
177
- # @!attribute [rw] metric_name
178
- # The name of the metric.
179
- # @return [String]
180
- #
181
- # @!attribute [rw] namespace
182
- # The namespace of the metric.
183
- # @return [String]
184
- #
185
- # @!attribute [rw] statistic
186
- # The statistic for the metric, other than percentiles. For percentile
187
- # statistics, use `ExtendedStatistics`.
188
- # @return [String]
189
- #
190
- # @!attribute [rw] extended_statistic
191
- # The percentile statistic for the metric. Specify a value between
192
- # p0.0 and p100.
193
- # @return [String]
194
- #
195
- # @!attribute [rw] dimensions
196
- # The dimensions associated with the metric. If the metric has any
197
- # associated dimensions, you must specify them in order for the call
198
- # to succeed.
199
- # @return [Array<Types::Dimension>]
200
- #
201
- # @!attribute [rw] period
202
- # The period, in seconds, over which the statistic is applied.
203
- # @return [Integer]
204
- #
205
- # @!attribute [rw] unit
206
- # The unit for the metric.
207
- # @return [String]
208
- class DescribeAlarmsForMetricInput < Struct.new(
209
- :metric_name,
210
- :namespace,
211
- :statistic,
212
- :extended_statistic,
213
- :dimensions,
214
- :period,
215
- :unit)
216
- include Aws::Structure
217
- end
161
+ # @!attribute [rw] alarm_history_items
162
+ # The alarm histories, in JSON format.
163
+ # @return [Array<Types::AlarmHistoryItem>]
164
+ #
165
+ # @!attribute [rw] next_token
166
+ # The token that marks the start of the next batch of returned
167
+ # results.
168
+ # @return [String]
169
+ #
170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryOutput AWS API Documentation
171
+ #
172
+ class DescribeAlarmHistoryOutput < Struct.new(
173
+ :alarm_history_items,
174
+ :next_token)
175
+ include Aws::Structure
176
+ end
218
177
 
219
- # @!attribute [rw] metric_alarms
220
- # The information for each alarm with the specified metric.
221
- # @return [Array<Types::MetricAlarm>]
222
- class DescribeAlarmsForMetricOutput < Struct.new(
223
- :metric_alarms)
224
- include Aws::Structure
225
- end
178
+ # @note When making an API call, you may pass DescribeAlarmsForMetricInput
179
+ # data as a hash:
180
+ #
181
+ # {
182
+ # metric_name: "MetricName", # required
183
+ # namespace: "Namespace", # required
184
+ # statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
185
+ # extended_statistic: "ExtendedStatistic",
186
+ # dimensions: [
187
+ # {
188
+ # name: "DimensionName", # required
189
+ # value: "DimensionValue", # required
190
+ # },
191
+ # ],
192
+ # period: 1,
193
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
194
+ # }
195
+ #
196
+ # @!attribute [rw] metric_name
197
+ # The name of the metric.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] namespace
201
+ # The namespace of the metric.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] statistic
205
+ # The statistic for the metric, other than percentiles. For percentile
206
+ # statistics, use `ExtendedStatistics`.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] extended_statistic
210
+ # The percentile statistic for the metric. Specify a value between
211
+ # p0.0 and p100.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] dimensions
215
+ # The dimensions associated with the metric. If the metric has any
216
+ # associated dimensions, you must specify them in order for the call
217
+ # to succeed.
218
+ # @return [Array<Types::Dimension>]
219
+ #
220
+ # @!attribute [rw] period
221
+ # The period, in seconds, over which the statistic is applied.
222
+ # @return [Integer]
223
+ #
224
+ # @!attribute [rw] unit
225
+ # The unit for the metric.
226
+ # @return [String]
227
+ #
228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricInput AWS API Documentation
229
+ #
230
+ class DescribeAlarmsForMetricInput < Struct.new(
231
+ :metric_name,
232
+ :namespace,
233
+ :statistic,
234
+ :extended_statistic,
235
+ :dimensions,
236
+ :period,
237
+ :unit)
238
+ include Aws::Structure
239
+ end
226
240
 
227
- # @note When making an API call, pass DescribeAlarmsInput
228
- # data as a hash:
229
- #
230
- # {
231
- # alarm_names: ["AlarmName"],
232
- # alarm_name_prefix: "AlarmNamePrefix",
233
- # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
234
- # action_prefix: "ActionPrefix",
235
- # max_records: 1,
236
- # next_token: "NextToken",
237
- # }
238
- # @!attribute [rw] alarm_names
239
- # The names of the alarms.
240
- # @return [Array<String>]
241
- #
242
- # @!attribute [rw] alarm_name_prefix
243
- # The alarm name prefix. You cannot specify `AlarmNames` if this
244
- # parameter is specified.
245
- # @return [String]
246
- #
247
- # @!attribute [rw] state_value
248
- # The state value to be used in matching alarms.
249
- # @return [String]
250
- #
251
- # @!attribute [rw] action_prefix
252
- # The action name prefix.
253
- # @return [String]
254
- #
255
- # @!attribute [rw] max_records
256
- # The maximum number of alarm descriptions to retrieve.
257
- # @return [Integer]
258
- #
259
- # @!attribute [rw] next_token
260
- # The token returned by a previous call to indicate that there is more
261
- # data available.
262
- # @return [String]
263
- class DescribeAlarmsInput < Struct.new(
264
- :alarm_names,
265
- :alarm_name_prefix,
266
- :state_value,
267
- :action_prefix,
268
- :max_records,
269
- :next_token)
270
- include Aws::Structure
271
- end
241
+ # @!attribute [rw] metric_alarms
242
+ # The information for each alarm with the specified metric.
243
+ # @return [Array<Types::MetricAlarm>]
244
+ #
245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricOutput AWS API Documentation
246
+ #
247
+ class DescribeAlarmsForMetricOutput < Struct.new(
248
+ :metric_alarms)
249
+ include Aws::Structure
250
+ end
272
251
 
273
- # @!attribute [rw] metric_alarms
274
- # The information for the specified alarms.
275
- # @return [Array<Types::MetricAlarm>]
276
- #
277
- # @!attribute [rw] next_token
278
- # The token that marks the start of the next batch of returned
279
- # results.
280
- # @return [String]
281
- class DescribeAlarmsOutput < Struct.new(
282
- :metric_alarms,
283
- :next_token)
284
- include Aws::Structure
285
- end
252
+ # @note When making an API call, you may pass DescribeAlarmsInput
253
+ # data as a hash:
254
+ #
255
+ # {
256
+ # alarm_names: ["AlarmName"],
257
+ # alarm_name_prefix: "AlarmNamePrefix",
258
+ # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
259
+ # action_prefix: "ActionPrefix",
260
+ # max_records: 1,
261
+ # next_token: "NextToken",
262
+ # }
263
+ #
264
+ # @!attribute [rw] alarm_names
265
+ # The names of the alarms.
266
+ # @return [Array<String>]
267
+ #
268
+ # @!attribute [rw] alarm_name_prefix
269
+ # The alarm name prefix. You cannot specify `AlarmNames` if this
270
+ # parameter is specified.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] state_value
274
+ # The state value to be used in matching alarms.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] action_prefix
278
+ # The action name prefix.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] max_records
282
+ # The maximum number of alarm descriptions to retrieve.
283
+ # @return [Integer]
284
+ #
285
+ # @!attribute [rw] next_token
286
+ # The token returned by a previous call to indicate that there is more
287
+ # data available.
288
+ # @return [String]
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsInput AWS API Documentation
291
+ #
292
+ class DescribeAlarmsInput < Struct.new(
293
+ :alarm_names,
294
+ :alarm_name_prefix,
295
+ :state_value,
296
+ :action_prefix,
297
+ :max_records,
298
+ :next_token)
299
+ include Aws::Structure
300
+ end
286
301
 
287
- # Expands the identity of a metric.
288
- # @note When making an API call, pass Dimension
289
- # data as a hash:
290
- #
291
- # {
292
- # name: "DimensionName", # required
293
- # value: "DimensionValue", # required
294
- # }
295
- # @!attribute [rw] name
296
- # The name of the dimension.
297
- # @return [String]
298
- #
299
- # @!attribute [rw] value
300
- # The value representing the dimension measurement.
301
- # @return [String]
302
- class Dimension < Struct.new(
303
- :name,
304
- :value)
305
- include Aws::Structure
306
- end
302
+ # @!attribute [rw] metric_alarms
303
+ # The information for the specified alarms.
304
+ # @return [Array<Types::MetricAlarm>]
305
+ #
306
+ # @!attribute [rw] next_token
307
+ # The token that marks the start of the next batch of returned
308
+ # results.
309
+ # @return [String]
310
+ #
311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsOutput AWS API Documentation
312
+ #
313
+ class DescribeAlarmsOutput < Struct.new(
314
+ :metric_alarms,
315
+ :next_token)
316
+ include Aws::Structure
317
+ end
307
318
 
308
- # Represents filters for a dimension.
309
- # @note When making an API call, pass DimensionFilter
310
- # data as a hash:
311
- #
312
- # {
313
- # name: "DimensionName", # required
314
- # value: "DimensionValue",
315
- # }
316
- # @!attribute [rw] name
317
- # The dimension name to be matched.
318
- # @return [String]
319
- #
320
- # @!attribute [rw] value
321
- # The value of the dimension to be matched.
322
- # @return [String]
323
- class DimensionFilter < Struct.new(
324
- :name,
325
- :value)
326
- include Aws::Structure
327
- end
319
+ # Expands the identity of a metric.
320
+ #
321
+ # @note When making an API call, you may pass Dimension
322
+ # data as a hash:
323
+ #
324
+ # {
325
+ # name: "DimensionName", # required
326
+ # value: "DimensionValue", # required
327
+ # }
328
+ #
329
+ # @!attribute [rw] name
330
+ # The name of the dimension.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] value
334
+ # The value representing the dimension measurement.
335
+ # @return [String]
336
+ #
337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension AWS API Documentation
338
+ #
339
+ class Dimension < Struct.new(
340
+ :name,
341
+ :value)
342
+ include Aws::Structure
343
+ end
328
344
 
329
- # @note When making an API call, pass DisableAlarmActionsInput
330
- # data as a hash:
331
- #
332
- # {
333
- # alarm_names: ["AlarmName"], # required
334
- # }
335
- # @!attribute [rw] alarm_names
336
- # The names of the alarms.
337
- # @return [Array<String>]
338
- class DisableAlarmActionsInput < Struct.new(
339
- :alarm_names)
340
- include Aws::Structure
341
- end
345
+ # Represents filters for a dimension.
346
+ #
347
+ # @note When making an API call, you may pass DimensionFilter
348
+ # data as a hash:
349
+ #
350
+ # {
351
+ # name: "DimensionName", # required
352
+ # value: "DimensionValue",
353
+ # }
354
+ #
355
+ # @!attribute [rw] name
356
+ # The dimension name to be matched.
357
+ # @return [String]
358
+ #
359
+ # @!attribute [rw] value
360
+ # The value of the dimension to be matched.
361
+ # @return [String]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DimensionFilter AWS API Documentation
364
+ #
365
+ class DimensionFilter < Struct.new(
366
+ :name,
367
+ :value)
368
+ include Aws::Structure
369
+ end
342
370
 
343
- # @note When making an API call, pass EnableAlarmActionsInput
344
- # data as a hash:
345
- #
346
- # {
347
- # alarm_names: ["AlarmName"], # required
348
- # }
349
- # @!attribute [rw] alarm_names
350
- # The names of the alarms.
351
- # @return [Array<String>]
352
- class EnableAlarmActionsInput < Struct.new(
353
- :alarm_names)
354
- include Aws::Structure
355
- end
371
+ # @note When making an API call, you may pass DisableAlarmActionsInput
372
+ # data as a hash:
373
+ #
374
+ # {
375
+ # alarm_names: ["AlarmName"], # required
376
+ # }
377
+ #
378
+ # @!attribute [rw] alarm_names
379
+ # The names of the alarms.
380
+ # @return [Array<String>]
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActionsInput AWS API Documentation
383
+ #
384
+ class DisableAlarmActionsInput < Struct.new(
385
+ :alarm_names)
386
+ include Aws::Structure
387
+ end
356
388
 
357
- # @note When making an API call, pass GetMetricStatisticsInput
358
- # data as a hash:
359
- #
360
- # {
361
- # namespace: "Namespace", # required
362
- # metric_name: "MetricName", # required
363
- # dimensions: [
364
- # {
365
- # name: "DimensionName", # required
366
- # value: "DimensionValue", # required
367
- # },
368
- # ],
369
- # start_time: Time.now, # required
370
- # end_time: Time.now, # required
371
- # period: 1, # required
372
- # statistics: ["SampleCount"], # accepts SampleCount, Average, Sum, Minimum, Maximum
373
- # extended_statistics: ["ExtendedStatistic"],
374
- # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
375
- # }
376
- # @!attribute [rw] namespace
377
- # The namespace of the metric, with or without spaces.
378
- # @return [String]
379
- #
380
- # @!attribute [rw] metric_name
381
- # The name of the metric, with or without spaces.
382
- # @return [String]
383
- #
384
- # @!attribute [rw] dimensions
385
- # The dimensions. CloudWatch treats each unique combination of
386
- # dimensions as a separate metric. You can't retrieve statistics
387
- # using combinations of dimensions that were not specially published.
388
- # You must specify the same dimensions that were used when the metrics
389
- # were created. For an example, see [Dimension Combinations][1] in the
390
- # *Amazon CloudWatch User Guide*.
391
- #
392
- #
393
- #
394
- # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations
395
- # @return [Array<Types::Dimension>]
396
- #
397
- # @!attribute [rw] start_time
398
- # The time stamp that determines the first data point to return. Note
399
- # that start times are evaluated relative to the time that CloudWatch
400
- # receives the request.
401
- #
402
- # The value specified is inclusive; results include data points with
403
- # the specified time stamp. The time stamp must be in ISO 8601 UTC
404
- # format (for example, 2016-10-03T23:00:00Z).
405
- #
406
- # CloudWatch rounds the specified time stamp as follows:
407
- #
408
- # * Start time less than 15 days ago - Round down to the nearest whole
409
- # minute. For example, 12:32:34 is rounded down to 12:32:00.
410
- #
411
- # * Start time between 15 and 63 days ago - Round down to the nearest
412
- # 5-minute clock interval. For example, 12:32:34 is rounded down to
413
- # 12:30:00.
414
- #
415
- # * Start time greater than 63 days ago - Round down to the nearest
416
- # 1-hour clock interval. For example, 12:32:34 is rounded down to
417
- # 12:00:00.
418
- # @return [Time]
419
- #
420
- # @!attribute [rw] end_time
421
- # The time stamp that determines the last data point to return.
422
- #
423
- # The value specified is exclusive; results will include data points
424
- # up to the specified time stamp. The time stamp must be in ISO 8601
425
- # UTC format (for example, 2016-10-10T23:00:00Z).
426
- # @return [Time]
427
- #
428
- # @!attribute [rw] period
429
- # The granularity, in seconds, of the returned data points. A period
430
- # can be as short as one minute (60 seconds) and must be a multiple of
431
- # 60. The default value is 60.
432
- #
433
- # If the `StartTime` parameter specifies a time stamp that is greater
434
- # than 15 days ago, you must specify the period as follows or no data
435
- # points in that time range is returned:
436
- #
437
- # * Start time between 15 and 63 days ago - Use a multiple of 300
438
- # seconds (5 minutes).
439
- #
440
- # * Start time greater than 63 days ago - Use a multiple of 3600
441
- # seconds (1 hour).
442
- # @return [Integer]
443
- #
444
- # @!attribute [rw] statistics
445
- # The metric statistics, other than percentile. For percentile
446
- # statistics, use `ExtendedStatistic`.
447
- # @return [Array<String>]
448
- #
449
- # @!attribute [rw] extended_statistics
450
- # The percentile statistics. Specify values between p0.0 and p100.
451
- # @return [Array<String>]
452
- #
453
- # @!attribute [rw] unit
454
- # The unit for a given metric. Metrics may be reported in multiple
455
- # units. Not supplying a unit results in all units being returned. If
456
- # the metric only ever reports one unit, specifying a unit has no
457
- # effect.
458
- # @return [String]
459
- class GetMetricStatisticsInput < Struct.new(
460
- :namespace,
461
- :metric_name,
462
- :dimensions,
463
- :start_time,
464
- :end_time,
465
- :period,
466
- :statistics,
467
- :extended_statistics,
468
- :unit)
469
- include Aws::Structure
470
- end
389
+ # @note When making an API call, you may pass EnableAlarmActionsInput
390
+ # data as a hash:
391
+ #
392
+ # {
393
+ # alarm_names: ["AlarmName"], # required
394
+ # }
395
+ #
396
+ # @!attribute [rw] alarm_names
397
+ # The names of the alarms.
398
+ # @return [Array<String>]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActionsInput AWS API Documentation
401
+ #
402
+ class EnableAlarmActionsInput < Struct.new(
403
+ :alarm_names)
404
+ include Aws::Structure
405
+ end
471
406
 
472
- # @!attribute [rw] label
473
- # A label for the specified metric.
474
- # @return [String]
475
- #
476
- # @!attribute [rw] datapoints
477
- # The data points for the specified metric.
478
- # @return [Array<Types::Datapoint>]
479
- class GetMetricStatisticsOutput < Struct.new(
480
- :label,
481
- :datapoints)
482
- include Aws::Structure
483
- end
407
+ # @note When making an API call, you may pass GetMetricStatisticsInput
408
+ # data as a hash:
409
+ #
410
+ # {
411
+ # namespace: "Namespace", # required
412
+ # metric_name: "MetricName", # required
413
+ # dimensions: [
414
+ # {
415
+ # name: "DimensionName", # required
416
+ # value: "DimensionValue", # required
417
+ # },
418
+ # ],
419
+ # start_time: Time.now, # required
420
+ # end_time: Time.now, # required
421
+ # period: 1, # required
422
+ # statistics: ["SampleCount"], # accepts SampleCount, Average, Sum, Minimum, Maximum
423
+ # extended_statistics: ["ExtendedStatistic"],
424
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
425
+ # }
426
+ #
427
+ # @!attribute [rw] namespace
428
+ # The namespace of the metric, with or without spaces.
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] metric_name
432
+ # The name of the metric, with or without spaces.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] dimensions
436
+ # The dimensions. If the metric contains multiple dimensions, you must
437
+ # include a value for each dimension. CloudWatch treats each unique
438
+ # combination of dimensions as a separate metric. You can't retrieve
439
+ # statistics using combinations of dimensions that were not specially
440
+ # published. You must specify the same dimensions that were used when
441
+ # the metrics were created. For an example, see [Dimension
442
+ # Combinations][1] in the *Amazon CloudWatch User Guide*. For more
443
+ # information on specifying dimensions, see [Publishing Metrics][2] in
444
+ # the *Amazon CloudWatch User Guide*.
445
+ #
446
+ #
447
+ #
448
+ # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations
449
+ # [2]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html
450
+ # @return [Array<Types::Dimension>]
451
+ #
452
+ # @!attribute [rw] start_time
453
+ # The time stamp that determines the first data point to return. Note
454
+ # that start times are evaluated relative to the time that CloudWatch
455
+ # receives the request.
456
+ #
457
+ # The value specified is inclusive; results include data points with
458
+ # the specified time stamp. The time stamp must be in ISO 8601 UTC
459
+ # format (for example, 2016-10-03T23:00:00Z).
460
+ #
461
+ # CloudWatch rounds the specified time stamp as follows:
462
+ #
463
+ # * Start time less than 15 days ago - Round down to the nearest whole
464
+ # minute. For example, 12:32:34 is rounded down to 12:32:00.
465
+ #
466
+ # * Start time between 15 and 63 days ago - Round down to the nearest
467
+ # 5-minute clock interval. For example, 12:32:34 is rounded down to
468
+ # 12:30:00.
469
+ #
470
+ # * Start time greater than 63 days ago - Round down to the nearest
471
+ # 1-hour clock interval. For example, 12:32:34 is rounded down to
472
+ # 12:00:00.
473
+ # @return [Time]
474
+ #
475
+ # @!attribute [rw] end_time
476
+ # The time stamp that determines the last data point to return.
477
+ #
478
+ # The value specified is exclusive; results will include data points
479
+ # up to the specified time stamp. The time stamp must be in ISO 8601
480
+ # UTC format (for example, 2016-10-10T23:00:00Z).
481
+ # @return [Time]
482
+ #
483
+ # @!attribute [rw] period
484
+ # The granularity, in seconds, of the returned data points. A period
485
+ # can be as short as one minute (60 seconds) and must be a multiple of
486
+ # 60. The default value is 60.
487
+ #
488
+ # If the `StartTime` parameter specifies a time stamp that is greater
489
+ # than 15 days ago, you must specify the period as follows or no data
490
+ # points in that time range is returned:
491
+ #
492
+ # * Start time between 15 and 63 days ago - Use a multiple of 300
493
+ # seconds (5 minutes).
494
+ #
495
+ # * Start time greater than 63 days ago - Use a multiple of 3600
496
+ # seconds (1 hour).
497
+ # @return [Integer]
498
+ #
499
+ # @!attribute [rw] statistics
500
+ # The metric statistics, other than percentile. For percentile
501
+ # statistics, use `ExtendedStatistic`.
502
+ # @return [Array<String>]
503
+ #
504
+ # @!attribute [rw] extended_statistics
505
+ # The percentile statistics. Specify values between p0.0 and p100.
506
+ # @return [Array<String>]
507
+ #
508
+ # @!attribute [rw] unit
509
+ # The unit for a given metric. Metrics may be reported in multiple
510
+ # units. Not supplying a unit results in all units being returned. If
511
+ # the metric only ever reports one unit, specifying a unit has no
512
+ # effect.
513
+ # @return [String]
514
+ #
515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsInput AWS API Documentation
516
+ #
517
+ class GetMetricStatisticsInput < Struct.new(
518
+ :namespace,
519
+ :metric_name,
520
+ :dimensions,
521
+ :start_time,
522
+ :end_time,
523
+ :period,
524
+ :statistics,
525
+ :extended_statistics,
526
+ :unit)
527
+ include Aws::Structure
528
+ end
484
529
 
485
- # @note When making an API call, pass ListMetricsInput
486
- # data as a hash:
487
- #
488
- # {
489
- # namespace: "Namespace",
490
- # metric_name: "MetricName",
491
- # dimensions: [
492
- # {
493
- # name: "DimensionName", # required
494
- # value: "DimensionValue",
495
- # },
496
- # ],
497
- # next_token: "NextToken",
498
- # }
499
- # @!attribute [rw] namespace
500
- # The namespace to filter against.
501
- # @return [String]
502
- #
503
- # @!attribute [rw] metric_name
504
- # The name of the metric to filter against.
505
- # @return [String]
506
- #
507
- # @!attribute [rw] dimensions
508
- # The dimensions to filter against.
509
- # @return [Array<Types::DimensionFilter>]
510
- #
511
- # @!attribute [rw] next_token
512
- # The token returned by a previous call to indicate that there is more
513
- # data available.
514
- # @return [String]
515
- class ListMetricsInput < Struct.new(
516
- :namespace,
517
- :metric_name,
518
- :dimensions,
519
- :next_token)
520
- include Aws::Structure
521
- end
530
+ # @!attribute [rw] label
531
+ # A label for the specified metric.
532
+ # @return [String]
533
+ #
534
+ # @!attribute [rw] datapoints
535
+ # The data points for the specified metric.
536
+ # @return [Array<Types::Datapoint>]
537
+ #
538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsOutput AWS API Documentation
539
+ #
540
+ class GetMetricStatisticsOutput < Struct.new(
541
+ :label,
542
+ :datapoints)
543
+ include Aws::Structure
544
+ end
522
545
 
523
- # @!attribute [rw] metrics
524
- # The metrics.
525
- # @return [Array<Types::Metric>]
526
- #
527
- # @!attribute [rw] next_token
528
- # The token that marks the start of the next batch of returned
529
- # results.
530
- # @return [String]
531
- class ListMetricsOutput < Struct.new(
532
- :metrics,
533
- :next_token)
534
- include Aws::Structure
535
- end
546
+ # @note When making an API call, you may pass ListMetricsInput
547
+ # data as a hash:
548
+ #
549
+ # {
550
+ # namespace: "Namespace",
551
+ # metric_name: "MetricName",
552
+ # dimensions: [
553
+ # {
554
+ # name: "DimensionName", # required
555
+ # value: "DimensionValue",
556
+ # },
557
+ # ],
558
+ # next_token: "NextToken",
559
+ # }
560
+ #
561
+ # @!attribute [rw] namespace
562
+ # The namespace to filter against.
563
+ # @return [String]
564
+ #
565
+ # @!attribute [rw] metric_name
566
+ # The name of the metric to filter against.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] dimensions
570
+ # The dimensions to filter against.
571
+ # @return [Array<Types::DimensionFilter>]
572
+ #
573
+ # @!attribute [rw] next_token
574
+ # The token returned by a previous call to indicate that there is more
575
+ # data available.
576
+ # @return [String]
577
+ #
578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput AWS API Documentation
579
+ #
580
+ class ListMetricsInput < Struct.new(
581
+ :namespace,
582
+ :metric_name,
583
+ :dimensions,
584
+ :next_token)
585
+ include Aws::Structure
586
+ end
536
587
 
537
- # Represents a specific metric.
538
- # @!attribute [rw] namespace
539
- # The namespace of the metric.
540
- # @return [String]
541
- #
542
- # @!attribute [rw] metric_name
543
- # The name of the metric.
544
- # @return [String]
545
- #
546
- # @!attribute [rw] dimensions
547
- # The dimensions for the metric.
548
- # @return [Array<Types::Dimension>]
549
- class Metric < Struct.new(
550
- :namespace,
551
- :metric_name,
552
- :dimensions)
553
- include Aws::Structure
554
- end
588
+ # @!attribute [rw] metrics
589
+ # The metrics.
590
+ # @return [Array<Types::Metric>]
591
+ #
592
+ # @!attribute [rw] next_token
593
+ # The token that marks the start of the next batch of returned
594
+ # results.
595
+ # @return [String]
596
+ #
597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsOutput AWS API Documentation
598
+ #
599
+ class ListMetricsOutput < Struct.new(
600
+ :metrics,
601
+ :next_token)
602
+ include Aws::Structure
603
+ end
555
604
 
556
- # Represents an alarm.
557
- # @!attribute [rw] alarm_name
558
- # The name of the alarm.
559
- # @return [String]
560
- #
561
- # @!attribute [rw] alarm_arn
562
- # The Amazon Resource Name (ARN) of the alarm.
563
- # @return [String]
564
- #
565
- # @!attribute [rw] alarm_description
566
- # The description of the alarm.
567
- # @return [String]
568
- #
569
- # @!attribute [rw] alarm_configuration_updated_timestamp
570
- # The time stamp of the last update to the alarm configuration.
571
- # @return [Time]
572
- #
573
- # @!attribute [rw] actions_enabled
574
- # Indicates whether actions should be executed during any changes to
575
- # the alarm state.
576
- # @return [Boolean]
577
- #
578
- # @!attribute [rw] ok_actions
579
- # The actions to execute when this alarm transitions to the `OK` state
580
- # from any other state. Each action is specified as an Amazon Resource
581
- # Name (ARN).
582
- # @return [Array<String>]
583
- #
584
- # @!attribute [rw] alarm_actions
585
- # The actions to execute when this alarm transitions to the `ALARM`
586
- # state from any other state. Each action is specified as an Amazon
587
- # Resource Name (ARN).
588
- # @return [Array<String>]
589
- #
590
- # @!attribute [rw] insufficient_data_actions
591
- # The actions to execute when this alarm transitions to the
592
- # `INSUFFICIENT_DATA` state from any other state. Each action is
593
- # specified as an Amazon Resource Name (ARN).
594
- # @return [Array<String>]
595
- #
596
- # @!attribute [rw] state_value
597
- # The state value for the alarm.
598
- # @return [String]
599
- #
600
- # @!attribute [rw] state_reason
601
- # An explanation for the alarm state, in text format.
602
- # @return [String]
603
- #
604
- # @!attribute [rw] state_reason_data
605
- # An explanation for the alarm state, in JSON format.
606
- # @return [String]
607
- #
608
- # @!attribute [rw] state_updated_timestamp
609
- # The time stamp of the last update to the alarm state.
610
- # @return [Time]
611
- #
612
- # @!attribute [rw] metric_name
613
- # The name of the metric associated with the alarm.
614
- # @return [String]
615
- #
616
- # @!attribute [rw] namespace
617
- # The namespace of the metric associated with the alarm.
618
- # @return [String]
619
- #
620
- # @!attribute [rw] statistic
621
- # The statistic for the metric associated with the alarm, other than
622
- # percentile. For percentile statistics, use `ExtendedStatistic`.
623
- # @return [String]
624
- #
625
- # @!attribute [rw] extended_statistic
626
- # The percentile statistic for the metric associated with the alarm.
627
- # Specify a value between p0.0 and p100.
628
- # @return [String]
629
- #
630
- # @!attribute [rw] dimensions
631
- # The dimensions for the metric associated with the alarm.
632
- # @return [Array<Types::Dimension>]
633
- #
634
- # @!attribute [rw] period
635
- # The period, in seconds, over which the statistic is applied.
636
- # @return [Integer]
637
- #
638
- # @!attribute [rw] unit
639
- # The unit of the metric associated with the alarm.
640
- # @return [String]
641
- #
642
- # @!attribute [rw] evaluation_periods
643
- # The number of periods over which data is compared to the specified
644
- # threshold.
645
- # @return [Integer]
646
- #
647
- # @!attribute [rw] threshold
648
- # The value to compare with the specified statistic.
649
- # @return [Float]
650
- #
651
- # @!attribute [rw] comparison_operator
652
- # The arithmetic operation to use when comparing the specified
653
- # statistic and threshold. The specified statistic value is used as
654
- # the first operand.
655
- # @return [String]
656
- class MetricAlarm < Struct.new(
657
- :alarm_name,
658
- :alarm_arn,
659
- :alarm_description,
660
- :alarm_configuration_updated_timestamp,
661
- :actions_enabled,
662
- :ok_actions,
663
- :alarm_actions,
664
- :insufficient_data_actions,
665
- :state_value,
666
- :state_reason,
667
- :state_reason_data,
668
- :state_updated_timestamp,
669
- :metric_name,
670
- :namespace,
671
- :statistic,
672
- :extended_statistic,
673
- :dimensions,
674
- :period,
675
- :unit,
676
- :evaluation_periods,
677
- :threshold,
678
- :comparison_operator)
679
- include Aws::Structure
680
- end
605
+ # Represents a specific metric.
606
+ #
607
+ # @!attribute [rw] namespace
608
+ # The namespace of the metric.
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] metric_name
612
+ # The name of the metric.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] dimensions
616
+ # The dimensions for the metric.
617
+ # @return [Array<Types::Dimension>]
618
+ #
619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Metric AWS API Documentation
620
+ #
621
+ class Metric < Struct.new(
622
+ :namespace,
623
+ :metric_name,
624
+ :dimensions)
625
+ include Aws::Structure
626
+ end
681
627
 
682
- # Encapsulates the information sent to either create a metric or add new
683
- # values to be aggregated into an existing metric.
684
- # @note When making an API call, pass MetricDatum
685
- # data as a hash:
686
- #
687
- # {
688
- # metric_name: "MetricName", # required
689
- # dimensions: [
690
- # {
691
- # name: "DimensionName", # required
692
- # value: "DimensionValue", # required
693
- # },
694
- # ],
695
- # timestamp: Time.now,
696
- # value: 1.0,
697
- # statistic_values: {
698
- # sample_count: 1.0, # required
699
- # sum: 1.0, # required
700
- # minimum: 1.0, # required
701
- # maximum: 1.0, # required
702
- # },
703
- # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
704
- # }
705
- # @!attribute [rw] metric_name
706
- # The name of the metric.
707
- # @return [String]
708
- #
709
- # @!attribute [rw] dimensions
710
- # The dimensions associated with the metric.
711
- # @return [Array<Types::Dimension>]
712
- #
713
- # @!attribute [rw] timestamp
714
- # The time the metric data was received, expressed as the number of
715
- # milliseconds since Jan 1, 1970 00:00:00 UTC.
716
- # @return [Time]
717
- #
718
- # @!attribute [rw] value
719
- # The value for the metric.
720
- #
721
- # Although the parameter accepts numbers of type Double, Amazon
722
- # CloudWatch rejects values that are either too small or too large.
723
- # Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base
724
- # 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for
725
- # example, NaN, +Infinity, -Infinity) are not supported.
726
- # @return [Float]
727
- #
728
- # @!attribute [rw] statistic_values
729
- # The statistical values for the metric.
730
- # @return [Types::StatisticSet]
731
- #
732
- # @!attribute [rw] unit
733
- # The unit of the metric.
734
- # @return [String]
735
- class MetricDatum < Struct.new(
736
- :metric_name,
737
- :dimensions,
738
- :timestamp,
739
- :value,
740
- :statistic_values,
741
- :unit)
742
- include Aws::Structure
743
- end
628
+ # Represents an alarm.
629
+ #
630
+ # @!attribute [rw] alarm_name
631
+ # The name of the alarm.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] alarm_arn
635
+ # The Amazon Resource Name (ARN) of the alarm.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] alarm_description
639
+ # The description of the alarm.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] alarm_configuration_updated_timestamp
643
+ # The time stamp of the last update to the alarm configuration.
644
+ # @return [Time]
645
+ #
646
+ # @!attribute [rw] actions_enabled
647
+ # Indicates whether actions should be executed during any changes to
648
+ # the alarm state.
649
+ # @return [Boolean]
650
+ #
651
+ # @!attribute [rw] ok_actions
652
+ # The actions to execute when this alarm transitions to the `OK` state
653
+ # from any other state. Each action is specified as an Amazon Resource
654
+ # Name (ARN).
655
+ # @return [Array<String>]
656
+ #
657
+ # @!attribute [rw] alarm_actions
658
+ # The actions to execute when this alarm transitions to the `ALARM`
659
+ # state from any other state. Each action is specified as an Amazon
660
+ # Resource Name (ARN).
661
+ # @return [Array<String>]
662
+ #
663
+ # @!attribute [rw] insufficient_data_actions
664
+ # The actions to execute when this alarm transitions to the
665
+ # `INSUFFICIENT_DATA` state from any other state. Each action is
666
+ # specified as an Amazon Resource Name (ARN).
667
+ # @return [Array<String>]
668
+ #
669
+ # @!attribute [rw] state_value
670
+ # The state value for the alarm.
671
+ # @return [String]
672
+ #
673
+ # @!attribute [rw] state_reason
674
+ # An explanation for the alarm state, in text format.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] state_reason_data
678
+ # An explanation for the alarm state, in JSON format.
679
+ # @return [String]
680
+ #
681
+ # @!attribute [rw] state_updated_timestamp
682
+ # The time stamp of the last update to the alarm state.
683
+ # @return [Time]
684
+ #
685
+ # @!attribute [rw] metric_name
686
+ # The name of the metric associated with the alarm.
687
+ # @return [String]
688
+ #
689
+ # @!attribute [rw] namespace
690
+ # The namespace of the metric associated with the alarm.
691
+ # @return [String]
692
+ #
693
+ # @!attribute [rw] statistic
694
+ # The statistic for the metric associated with the alarm, other than
695
+ # percentile. For percentile statistics, use `ExtendedStatistic`.
696
+ # @return [String]
697
+ #
698
+ # @!attribute [rw] extended_statistic
699
+ # The percentile statistic for the metric associated with the alarm.
700
+ # Specify a value between p0.0 and p100.
701
+ # @return [String]
702
+ #
703
+ # @!attribute [rw] dimensions
704
+ # The dimensions for the metric associated with the alarm.
705
+ # @return [Array<Types::Dimension>]
706
+ #
707
+ # @!attribute [rw] period
708
+ # The period, in seconds, over which the statistic is applied.
709
+ # @return [Integer]
710
+ #
711
+ # @!attribute [rw] unit
712
+ # The unit of the metric associated with the alarm.
713
+ # @return [String]
714
+ #
715
+ # @!attribute [rw] evaluation_periods
716
+ # The number of periods over which data is compared to the specified
717
+ # threshold.
718
+ # @return [Integer]
719
+ #
720
+ # @!attribute [rw] threshold
721
+ # The value to compare with the specified statistic.
722
+ # @return [Float]
723
+ #
724
+ # @!attribute [rw] comparison_operator
725
+ # The arithmetic operation to use when comparing the specified
726
+ # statistic and threshold. The specified statistic value is used as
727
+ # the first operand.
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] treat_missing_data
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] evaluate_low_sample_count_percentile
734
+ # @return [String]
735
+ #
736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm AWS API Documentation
737
+ #
738
+ class MetricAlarm < Struct.new(
739
+ :alarm_name,
740
+ :alarm_arn,
741
+ :alarm_description,
742
+ :alarm_configuration_updated_timestamp,
743
+ :actions_enabled,
744
+ :ok_actions,
745
+ :alarm_actions,
746
+ :insufficient_data_actions,
747
+ :state_value,
748
+ :state_reason,
749
+ :state_reason_data,
750
+ :state_updated_timestamp,
751
+ :metric_name,
752
+ :namespace,
753
+ :statistic,
754
+ :extended_statistic,
755
+ :dimensions,
756
+ :period,
757
+ :unit,
758
+ :evaluation_periods,
759
+ :threshold,
760
+ :comparison_operator,
761
+ :treat_missing_data,
762
+ :evaluate_low_sample_count_percentile)
763
+ include Aws::Structure
764
+ end
744
765
 
745
- # @note When making an API call, pass PutMetricAlarmInput
746
- # data as a hash:
747
- #
748
- # {
749
- # alarm_name: "AlarmName", # required
750
- # alarm_description: "AlarmDescription",
751
- # actions_enabled: false,
752
- # ok_actions: ["ResourceName"],
753
- # alarm_actions: ["ResourceName"],
754
- # insufficient_data_actions: ["ResourceName"],
755
- # metric_name: "MetricName", # required
756
- # namespace: "Namespace", # required
757
- # statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
758
- # extended_statistic: "ExtendedStatistic",
759
- # dimensions: [
760
- # {
761
- # name: "DimensionName", # required
762
- # value: "DimensionValue", # required
763
- # },
764
- # ],
765
- # period: 1, # required
766
- # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
767
- # evaluation_periods: 1, # required
768
- # threshold: 1.0, # required
769
- # comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
770
- # }
771
- # @!attribute [rw] alarm_name
772
- # The name for the alarm. This name must be unique within the AWS
773
- # account.
774
- # @return [String]
775
- #
776
- # @!attribute [rw] alarm_description
777
- # The description for the alarm.
778
- # @return [String]
779
- #
780
- # @!attribute [rw] actions_enabled
781
- # Indicates whether actions should be executed during any changes to
782
- # the alarm state.
783
- # @return [Boolean]
784
- #
785
- # @!attribute [rw] ok_actions
786
- # The actions to execute when this alarm transitions to an `OK` state
787
- # from any other state. Each action is specified as an Amazon Resource
788
- # Name (ARN).
789
- #
790
- # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
791
- # arn:aws:automate:*region*\:ec2:terminate \|
792
- # arn:aws:automate:*region*\:ec2:recover
793
- #
794
- # Valid Values (for use with IAM roles):
795
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
796
- # \|
797
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
798
- # \|
799
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
800
- # @return [Array<String>]
801
- #
802
- # @!attribute [rw] alarm_actions
803
- # The actions to execute when this alarm transitions to the `ALARM`
804
- # state from any other state. Each action is specified as an Amazon
805
- # Resource Name (ARN).
806
- #
807
- # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
808
- # arn:aws:automate:*region*\:ec2:terminate \|
809
- # arn:aws:automate:*region*\:ec2:recover
810
- #
811
- # Valid Values (for use with IAM roles):
812
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
813
- # \|
814
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
815
- # \|
816
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
817
- # @return [Array<String>]
818
- #
819
- # @!attribute [rw] insufficient_data_actions
820
- # The actions to execute when this alarm transitions to the
821
- # `INSUFFICIENT_DATA` state from any other state. Each action is
822
- # specified as an Amazon Resource Name (ARN).
823
- #
824
- # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
825
- # arn:aws:automate:*region*\:ec2:terminate \|
826
- # arn:aws:automate:*region*\:ec2:recover
827
- #
828
- # Valid Values (for use with IAM roles):
829
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
830
- # \|
831
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
832
- # \|
833
- # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
834
- # @return [Array<String>]
835
- #
836
- # @!attribute [rw] metric_name
837
- # The name for the metric associated with the alarm.
838
- # @return [String]
839
- #
840
- # @!attribute [rw] namespace
841
- # The namespace for the metric associated with the alarm.
842
- # @return [String]
843
- #
844
- # @!attribute [rw] statistic
845
- # The statistic for the metric associated with the alarm, other than
846
- # percentile. For percentile statistics, use `ExtendedStatistic`.
847
- # @return [String]
848
- #
849
- # @!attribute [rw] extended_statistic
850
- # The percentile statistic for the metric associated with the alarm.
851
- # Specify a value between p0.0 and p100.
852
- # @return [String]
853
- #
854
- # @!attribute [rw] dimensions
855
- # The dimensions for the metric associated with the alarm.
856
- # @return [Array<Types::Dimension>]
857
- #
858
- # @!attribute [rw] period
859
- # The period, in seconds, over which the specified statistic is
860
- # applied.
861
- # @return [Integer]
862
- #
863
- # @!attribute [rw] unit
864
- # The unit of measure for the statistic. For example, the units for
865
- # the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks
866
- # the number of bytes that an instance receives on all network
867
- # interfaces. You can also specify a unit when you create a custom
868
- # metric. Units help provide conceptual meaning to your data. Metric
869
- # data points that specify a unit of measure, such as Percent, are
870
- # aggregated separately.
871
- #
872
- # If you specify a unit, you must use a unit that is appropriate for
873
- # the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in
874
- # the `INSUFFICIENT DATA` state.
875
- # @return [String]
876
- #
877
- # @!attribute [rw] evaluation_periods
878
- # The number of periods over which data is compared to the specified
879
- # threshold.
880
- # @return [Integer]
881
- #
882
- # @!attribute [rw] threshold
883
- # The value against which the specified statistic is compared.
884
- # @return [Float]
885
- #
886
- # @!attribute [rw] comparison_operator
887
- # The arithmetic operation to use when comparing the specified
888
- # statistic and threshold. The specified statistic value is used as
889
- # the first operand.
890
- # @return [String]
891
- class PutMetricAlarmInput < Struct.new(
892
- :alarm_name,
893
- :alarm_description,
894
- :actions_enabled,
895
- :ok_actions,
896
- :alarm_actions,
897
- :insufficient_data_actions,
898
- :metric_name,
899
- :namespace,
900
- :statistic,
901
- :extended_statistic,
902
- :dimensions,
903
- :period,
904
- :unit,
905
- :evaluation_periods,
906
- :threshold,
907
- :comparison_operator)
908
- include Aws::Structure
909
- end
766
+ # Encapsulates the information sent to either create a metric or add new
767
+ # values to be aggregated into an existing metric.
768
+ #
769
+ # @note When making an API call, you may pass MetricDatum
770
+ # data as a hash:
771
+ #
772
+ # {
773
+ # metric_name: "MetricName", # required
774
+ # dimensions: [
775
+ # {
776
+ # name: "DimensionName", # required
777
+ # value: "DimensionValue", # required
778
+ # },
779
+ # ],
780
+ # timestamp: Time.now,
781
+ # value: 1.0,
782
+ # statistic_values: {
783
+ # sample_count: 1.0, # required
784
+ # sum: 1.0, # required
785
+ # minimum: 1.0, # required
786
+ # maximum: 1.0, # required
787
+ # },
788
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
789
+ # }
790
+ #
791
+ # @!attribute [rw] metric_name
792
+ # The name of the metric.
793
+ # @return [String]
794
+ #
795
+ # @!attribute [rw] dimensions
796
+ # The dimensions associated with the metric.
797
+ # @return [Array<Types::Dimension>]
798
+ #
799
+ # @!attribute [rw] timestamp
800
+ # The time the metric data was received, expressed as the number of
801
+ # milliseconds since Jan 1, 1970 00:00:00 UTC.
802
+ # @return [Time]
803
+ #
804
+ # @!attribute [rw] value
805
+ # The value for the metric.
806
+ #
807
+ # Although the parameter accepts numbers of type Double, Amazon
808
+ # CloudWatch rejects values that are either too small or too large.
809
+ # Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base
810
+ # 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for
811
+ # example, NaN, +Infinity, -Infinity) are not supported.
812
+ # @return [Float]
813
+ #
814
+ # @!attribute [rw] statistic_values
815
+ # The statistical values for the metric.
816
+ # @return [Types::StatisticSet]
817
+ #
818
+ # @!attribute [rw] unit
819
+ # The unit of the metric.
820
+ # @return [String]
821
+ #
822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDatum AWS API Documentation
823
+ #
824
+ class MetricDatum < Struct.new(
825
+ :metric_name,
826
+ :dimensions,
827
+ :timestamp,
828
+ :value,
829
+ :statistic_values,
830
+ :unit)
831
+ include Aws::Structure
832
+ end
910
833
 
911
- # @note When making an API call, pass PutMetricDataInput
912
- # data as a hash:
913
- #
914
- # {
915
- # namespace: "Namespace", # required
916
- # metric_data: [ # required
917
- # {
918
- # metric_name: "MetricName", # required
919
- # dimensions: [
920
- # {
921
- # name: "DimensionName", # required
922
- # value: "DimensionValue", # required
923
- # },
924
- # ],
925
- # timestamp: Time.now,
926
- # value: 1.0,
927
- # statistic_values: {
928
- # sample_count: 1.0, # required
929
- # sum: 1.0, # required
930
- # minimum: 1.0, # required
931
- # maximum: 1.0, # required
932
- # },
933
- # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
934
- # },
935
- # ],
936
- # }
937
- # @!attribute [rw] namespace
938
- # The namespace for the metric data.
939
- #
940
- # You cannot specify a namespace that begins with "AWS/". Namespaces
941
- # that begin with "AWS/" are reserved for use by Amazon Web Services
942
- # products.
943
- # @return [String]
944
- #
945
- # @!attribute [rw] metric_data
946
- # The data for the metric.
947
- # @return [Array<Types::MetricDatum>]
948
- class PutMetricDataInput < Struct.new(
949
- :namespace,
950
- :metric_data)
951
- include Aws::Structure
952
- end
834
+ # @note When making an API call, you may pass PutMetricAlarmInput
835
+ # data as a hash:
836
+ #
837
+ # {
838
+ # alarm_name: "AlarmName", # required
839
+ # alarm_description: "AlarmDescription",
840
+ # actions_enabled: false,
841
+ # ok_actions: ["ResourceName"],
842
+ # alarm_actions: ["ResourceName"],
843
+ # insufficient_data_actions: ["ResourceName"],
844
+ # metric_name: "MetricName", # required
845
+ # namespace: "Namespace", # required
846
+ # statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
847
+ # extended_statistic: "ExtendedStatistic",
848
+ # dimensions: [
849
+ # {
850
+ # name: "DimensionName", # required
851
+ # value: "DimensionValue", # required
852
+ # },
853
+ # ],
854
+ # period: 1, # required
855
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
856
+ # evaluation_periods: 1, # required
857
+ # threshold: 1.0, # required
858
+ # comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
859
+ # treat_missing_data: "TreatMissingData",
860
+ # evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
861
+ # }
862
+ #
863
+ # @!attribute [rw] alarm_name
864
+ # The name for the alarm. This name must be unique within the AWS
865
+ # account.
866
+ # @return [String]
867
+ #
868
+ # @!attribute [rw] alarm_description
869
+ # The description for the alarm.
870
+ # @return [String]
871
+ #
872
+ # @!attribute [rw] actions_enabled
873
+ # Indicates whether actions should be executed during any changes to
874
+ # the alarm state.
875
+ # @return [Boolean]
876
+ #
877
+ # @!attribute [rw] ok_actions
878
+ # The actions to execute when this alarm transitions to an `OK` state
879
+ # from any other state. Each action is specified as an Amazon Resource
880
+ # Name (ARN).
881
+ #
882
+ # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
883
+ # arn:aws:automate:*region*\:ec2:terminate \|
884
+ # arn:aws:automate:*region*\:ec2:recover
885
+ #
886
+ # Valid Values (for use with IAM roles):
887
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
888
+ # \|
889
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
890
+ # \|
891
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
892
+ # @return [Array<String>]
893
+ #
894
+ # @!attribute [rw] alarm_actions
895
+ # The actions to execute when this alarm transitions to the `ALARM`
896
+ # state from any other state. Each action is specified as an Amazon
897
+ # Resource Name (ARN).
898
+ #
899
+ # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
900
+ # arn:aws:automate:*region*\:ec2:terminate \|
901
+ # arn:aws:automate:*region*\:ec2:recover
902
+ #
903
+ # Valid Values (for use with IAM roles):
904
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
905
+ # \|
906
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
907
+ # \|
908
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
909
+ # @return [Array<String>]
910
+ #
911
+ # @!attribute [rw] insufficient_data_actions
912
+ # The actions to execute when this alarm transitions to the
913
+ # `INSUFFICIENT_DATA` state from any other state. Each action is
914
+ # specified as an Amazon Resource Name (ARN).
915
+ #
916
+ # Valid Values: arn:aws:automate:*region*\:ec2:stop \|
917
+ # arn:aws:automate:*region*\:ec2:terminate \|
918
+ # arn:aws:automate:*region*\:ec2:recover
919
+ #
920
+ # Valid Values (for use with IAM roles):
921
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Stop/1.0
922
+ # \|
923
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Terminate/1.0
924
+ # \|
925
+ # arn:aws:swf:us-east-1:\\\{*customer-account*\\}:action/actions/AWS\_EC2.InstanceId.Reboot/1.0
926
+ # @return [Array<String>]
927
+ #
928
+ # @!attribute [rw] metric_name
929
+ # The name for the metric associated with the alarm.
930
+ # @return [String]
931
+ #
932
+ # @!attribute [rw] namespace
933
+ # The namespace for the metric associated with the alarm.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] statistic
937
+ # The statistic for the metric associated with the alarm, other than
938
+ # percentile. For percentile statistics, use `ExtendedStatistic`.
939
+ # @return [String]
940
+ #
941
+ # @!attribute [rw] extended_statistic
942
+ # The percentile statistic for the metric associated with the alarm.
943
+ # Specify a value between p0.0 and p100.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] dimensions
947
+ # The dimensions for the metric associated with the alarm.
948
+ # @return [Array<Types::Dimension>]
949
+ #
950
+ # @!attribute [rw] period
951
+ # The period, in seconds, over which the specified statistic is
952
+ # applied.
953
+ # @return [Integer]
954
+ #
955
+ # @!attribute [rw] unit
956
+ # The unit of measure for the statistic. For example, the units for
957
+ # the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks
958
+ # the number of bytes that an instance receives on all network
959
+ # interfaces. You can also specify a unit when you create a custom
960
+ # metric. Units help provide conceptual meaning to your data. Metric
961
+ # data points that specify a unit of measure, such as Percent, are
962
+ # aggregated separately.
963
+ #
964
+ # If you specify a unit, you must use a unit that is appropriate for
965
+ # the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in
966
+ # the `INSUFFICIENT DATA` state.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] evaluation_periods
970
+ # The number of periods over which data is compared to the specified
971
+ # threshold.
972
+ # @return [Integer]
973
+ #
974
+ # @!attribute [rw] threshold
975
+ # The value against which the specified statistic is compared.
976
+ # @return [Float]
977
+ #
978
+ # @!attribute [rw] comparison_operator
979
+ # The arithmetic operation to use when comparing the specified
980
+ # statistic and threshold. The specified statistic value is used as
981
+ # the first operand.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] treat_missing_data
985
+ # Sets how this alarm is to handle missing data points. If
986
+ # `TreatMissingData` is omitted, the default behavior of `missing` is
987
+ # used. For more information, see [Configuring How CloudWatch Alarms
988
+ # Treats Missing Data][1].
989
+ #
990
+ # Valid Values: `breaching | notBreaching | ignore | missing`
991
+ #
992
+ #
993
+ #
994
+ # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] evaluate_low_sample_count_percentile
998
+ # Used only for alarms based on percentiles. If you specify `ignore`,
999
+ # the alarm state will not change during periods with too few data
1000
+ # points to be statistically significant. If you specify `evaluate` or
1001
+ # omit this parameter, the alarm will always be evaluated and possibly
1002
+ # change state no matter how many data points are available. For more
1003
+ # information, see [Percentile-Based CloudWatch Alarms and Low Data
1004
+ # Samples][1].
1005
+ #
1006
+ # Valid Values: `evaluate | ignore`
1007
+ #
1008
+ #
1009
+ #
1010
+ # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
1011
+ # @return [String]
1012
+ #
1013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmInput AWS API Documentation
1014
+ #
1015
+ class PutMetricAlarmInput < Struct.new(
1016
+ :alarm_name,
1017
+ :alarm_description,
1018
+ :actions_enabled,
1019
+ :ok_actions,
1020
+ :alarm_actions,
1021
+ :insufficient_data_actions,
1022
+ :metric_name,
1023
+ :namespace,
1024
+ :statistic,
1025
+ :extended_statistic,
1026
+ :dimensions,
1027
+ :period,
1028
+ :unit,
1029
+ :evaluation_periods,
1030
+ :threshold,
1031
+ :comparison_operator,
1032
+ :treat_missing_data,
1033
+ :evaluate_low_sample_count_percentile)
1034
+ include Aws::Structure
1035
+ end
953
1036
 
954
- # @note When making an API call, pass SetAlarmStateInput
955
- # data as a hash:
956
- #
957
- # {
958
- # alarm_name: "AlarmName", # required
959
- # state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
960
- # state_reason: "StateReason", # required
961
- # state_reason_data: "StateReasonData",
962
- # }
963
- # @!attribute [rw] alarm_name
964
- # The name for the alarm. This name must be unique within the AWS
965
- # account. The maximum length is 255 characters.
966
- # @return [String]
967
- #
968
- # @!attribute [rw] state_value
969
- # The value of the state.
970
- # @return [String]
971
- #
972
- # @!attribute [rw] state_reason
973
- # The reason that this alarm is set to this specific state, in text
974
- # format.
975
- # @return [String]
976
- #
977
- # @!attribute [rw] state_reason_data
978
- # The reason that this alarm is set to this specific state, in JSON
979
- # format.
980
- # @return [String]
981
- class SetAlarmStateInput < Struct.new(
982
- :alarm_name,
983
- :state_value,
984
- :state_reason,
985
- :state_reason_data)
986
- include Aws::Structure
987
- end
1037
+ # @note When making an API call, you may pass PutMetricDataInput
1038
+ # data as a hash:
1039
+ #
1040
+ # {
1041
+ # namespace: "Namespace", # required
1042
+ # metric_data: [ # required
1043
+ # {
1044
+ # metric_name: "MetricName", # required
1045
+ # dimensions: [
1046
+ # {
1047
+ # name: "DimensionName", # required
1048
+ # value: "DimensionValue", # required
1049
+ # },
1050
+ # ],
1051
+ # timestamp: Time.now,
1052
+ # value: 1.0,
1053
+ # statistic_values: {
1054
+ # sample_count: 1.0, # required
1055
+ # sum: 1.0, # required
1056
+ # minimum: 1.0, # required
1057
+ # maximum: 1.0, # required
1058
+ # },
1059
+ # unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
1060
+ # },
1061
+ # ],
1062
+ # }
1063
+ #
1064
+ # @!attribute [rw] namespace
1065
+ # The namespace for the metric data.
1066
+ #
1067
+ # You cannot specify a namespace that begins with "AWS/". Namespaces
1068
+ # that begin with "AWS/" are reserved for use by Amazon Web Services
1069
+ # products.
1070
+ # @return [String]
1071
+ #
1072
+ # @!attribute [rw] metric_data
1073
+ # The data for the metric.
1074
+ # @return [Array<Types::MetricDatum>]
1075
+ #
1076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricDataInput AWS API Documentation
1077
+ #
1078
+ class PutMetricDataInput < Struct.new(
1079
+ :namespace,
1080
+ :metric_data)
1081
+ include Aws::Structure
1082
+ end
988
1083
 
989
- # Represents a set of statistics that describes a specific metric.
990
- # @note When making an API call, pass StatisticSet
991
- # data as a hash:
992
- #
993
- # {
994
- # sample_count: 1.0, # required
995
- # sum: 1.0, # required
996
- # minimum: 1.0, # required
997
- # maximum: 1.0, # required
998
- # }
999
- # @!attribute [rw] sample_count
1000
- # The number of samples used for the statistic set.
1001
- # @return [Float]
1002
- #
1003
- # @!attribute [rw] sum
1004
- # The sum of values for the sample set.
1005
- # @return [Float]
1006
- #
1007
- # @!attribute [rw] minimum
1008
- # The minimum value of the sample set.
1009
- # @return [Float]
1010
- #
1011
- # @!attribute [rw] maximum
1012
- # The maximum value of the sample set.
1013
- # @return [Float]
1014
- class StatisticSet < Struct.new(
1015
- :sample_count,
1016
- :sum,
1017
- :minimum,
1018
- :maximum)
1019
- include Aws::Structure
1020
- end
1084
+ # @note When making an API call, you may pass SetAlarmStateInput
1085
+ # data as a hash:
1086
+ #
1087
+ # {
1088
+ # alarm_name: "AlarmName", # required
1089
+ # state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
1090
+ # state_reason: "StateReason", # required
1091
+ # state_reason_data: "StateReasonData",
1092
+ # }
1093
+ #
1094
+ # @!attribute [rw] alarm_name
1095
+ # The name for the alarm. This name must be unique within the AWS
1096
+ # account. The maximum length is 255 characters.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] state_value
1100
+ # The value of the state.
1101
+ # @return [String]
1102
+ #
1103
+ # @!attribute [rw] state_reason
1104
+ # The reason that this alarm is set to this specific state, in text
1105
+ # format.
1106
+ # @return [String]
1107
+ #
1108
+ # @!attribute [rw] state_reason_data
1109
+ # The reason that this alarm is set to this specific state, in JSON
1110
+ # format.
1111
+ # @return [String]
1112
+ #
1113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateInput AWS API Documentation
1114
+ #
1115
+ class SetAlarmStateInput < Struct.new(
1116
+ :alarm_name,
1117
+ :state_value,
1118
+ :state_reason,
1119
+ :state_reason_data)
1120
+ include Aws::Structure
1121
+ end
1021
1122
 
1123
+ # Represents a set of statistics that describes a specific metric.
1124
+ #
1125
+ # @note When making an API call, you may pass StatisticSet
1126
+ # data as a hash:
1127
+ #
1128
+ # {
1129
+ # sample_count: 1.0, # required
1130
+ # sum: 1.0, # required
1131
+ # minimum: 1.0, # required
1132
+ # maximum: 1.0, # required
1133
+ # }
1134
+ #
1135
+ # @!attribute [rw] sample_count
1136
+ # The number of samples used for the statistic set.
1137
+ # @return [Float]
1138
+ #
1139
+ # @!attribute [rw] sum
1140
+ # The sum of values for the sample set.
1141
+ # @return [Float]
1142
+ #
1143
+ # @!attribute [rw] minimum
1144
+ # The minimum value of the sample set.
1145
+ # @return [Float]
1146
+ #
1147
+ # @!attribute [rw] maximum
1148
+ # The maximum value of the sample set.
1149
+ # @return [Float]
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StatisticSet AWS API Documentation
1152
+ #
1153
+ class StatisticSet < Struct.new(
1154
+ :sample_count,
1155
+ :sum,
1156
+ :minimum,
1157
+ :maximum)
1158
+ include Aws::Structure
1022
1159
  end
1160
+
1023
1161
  end
1024
1162
  end