aws-sdk-health 1.0.0.rc2 → 1.0.0.rc3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/lib/aws-sdk-health.rb +1 -1
  3. data/lib/aws-sdk-health/client.rb +548 -488
  4. data/lib/aws-sdk-health/client_api.rb +351 -353
  5. data/lib/aws-sdk-health/errors.rb +4 -13
  6. data/lib/aws-sdk-health/resource.rb +12 -14
  7. data/lib/aws-sdk-health/types.rb +847 -794
  8. metadata +2 -2
data/lib/aws-sdk-health/errors.rb CHANGED
@@ -1,23 +1,14 @@
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 Health
10
- module Errors
8
+ module Aws::Health
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
data/lib/aws-sdk-health/resource.rb CHANGED
@@ -1,25 +1,23 @@
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 Health
10
- class Resource
8
+ module Aws::Health
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
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
data/lib/aws-sdk-health/types.rb CHANGED
@@ -1,827 +1,880 @@
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 Health
10
- module Types
8
+ module Aws::Health
9
+ module Types
11
10
 
12
- # Information about an entity that is affected by a Health event.
13
- # @!attribute [rw] entity_arn
14
- # The unique identifier for the entity. Format:
15
- # `arn:aws:health:entity-region:aws-account:entity/entity-id `.
16
- # Example:
17
- # `arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K`
18
- # @return [String]
19
- #
20
- # @!attribute [rw] event_arn
21
- # The unique identifier for the event. Format:
22
- # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
23
- # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
24
- # @return [String]
25
- #
26
- # @!attribute [rw] entity_value
27
- # The ID of the affected entity.
28
- # @return [String]
29
- #
30
- # @!attribute [rw] aws_account_id
31
- # The 12-digit AWS account number that contains the affected entity.
32
- # @return [String]
33
- #
34
- # @!attribute [rw] last_updated_time
35
- # The most recent time that the entity was updated.
36
- # @return [Time]
37
- #
38
- # @!attribute [rw] status_code
39
- # The most recent status of the entity affected by the event. The
40
- # possible values are `IMPAIRED`, `UNIMPAIRED`, and `UNKNOWN`.
41
- # @return [String]
42
- #
43
- # @!attribute [rw] tags
44
- # A map of entity tags attached to the affected entity.
45
- # @return [Hash<String,String>]
46
- class AffectedEntity < Struct.new(
47
- :entity_arn,
48
- :event_arn,
49
- :entity_value,
50
- :aws_account_id,
51
- :last_updated_time,
52
- :status_code,
53
- :tags)
54
- include Aws::Structure
55
- end
56
-
57
- # A range of dates and times that is used by the EventFilter and
58
- # EntityFilter objects. If `from` is set and `to` is set: match items
59
- # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) is
60
- # between `from` and `to` inclusive. If `from` is set and `to` is not
61
- # set: match items where the timestamp value is equal to or after
62
- # `from`. If `from` is not set and `to` is set: match items where the
63
- # timestamp value is equal to or before `to`.
64
- # @note When making an API call, pass DateTimeRange
65
- # data as a hash:
66
- #
67
- # {
68
- # from: Time.now,
69
- # to: Time.now,
70
- # }
71
- # @!attribute [rw] from
72
- # The starting date and time of a time range.
73
- # @return [Time]
74
- #
75
- # @!attribute [rw] to
76
- # The ending date and time of a time range.
77
- # @return [Time]
78
- class DateTimeRange < Struct.new(
79
- :from,
80
- :to)
81
- include Aws::Structure
82
- end
11
+ # Information about an entity that is affected by a Health event.
12
+ #
13
+ # @!attribute [rw] entity_arn
14
+ # The unique identifier for the entity. Format:
15
+ # `arn:aws:health:entity-region:aws-account:entity/entity-id `.
16
+ # Example:
17
+ # `arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K`
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] event_arn
21
+ # The unique identifier for the event. Format:
22
+ # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
23
+ # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] entity_value
27
+ # The ID of the affected entity.
28
+ # @return [String]
29
+ #
30
+ # @!attribute [rw] aws_account_id
31
+ # The 12-digit AWS account number that contains the affected entity.
32
+ # @return [String]
33
+ #
34
+ # @!attribute [rw] last_updated_time
35
+ # The most recent time that the entity was updated.
36
+ # @return [Time]
37
+ #
38
+ # @!attribute [rw] status_code
39
+ # The most recent status of the entity affected by the event. The
40
+ # possible values are `IMPAIRED`, `UNIMPAIRED`, and `UNKNOWN`.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] tags
44
+ # A map of entity tags attached to the affected entity.
45
+ # @return [Hash<String,String>]
46
+ #
47
+ class AffectedEntity < Struct.new(
48
+ :entity_arn,
49
+ :event_arn,
50
+ :entity_value,
51
+ :aws_account_id,
52
+ :last_updated_time,
53
+ :status_code,
54
+ :tags)
55
+ include Aws::Structure
56
+ end
83
57
 
84
- # @note When making an API call, pass DescribeAffectedEntitiesRequest
85
- # data as a hash:
86
- #
87
- # {
88
- # filter: { # required
89
- # event_arns: ["eventArn"], # required
90
- # entity_arns: ["entityArn"],
91
- # entity_values: ["entityValue"],
92
- # last_updated_times: [
93
- # {
94
- # from: Time.now,
95
- # to: Time.now,
96
- # },
97
- # ],
98
- # tags: [
99
- # {
100
- # "tagKey" => "tagValue",
101
- # },
102
- # ],
103
- # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
104
- # },
105
- # locale: "locale",
106
- # next_token: "nextToken",
107
- # max_results: 1,
108
- # }
109
- # @!attribute [rw] filter
110
- # Values to narrow the results returned. At least one event ARN is
111
- # required.
112
- # @return [Types::EntityFilter]
113
- #
114
- # @!attribute [rw] locale
115
- # The locale (language) to return information in. The default is
116
- # English.
117
- # @return [String]
118
- #
119
- # @!attribute [rw] next_token
120
- # If the results of a search are large, only a portion of the results
121
- # are returned, and a `nextToken` pagination token is returned in the
122
- # response. To retrieve the next batch of results, reissue the search
123
- # request and include the returned token. When all results have been
124
- # returned, the response does not contain a pagination token value.
125
- # @return [String]
126
- #
127
- # @!attribute [rw] max_results
128
- # The maximum number of items to return in one batch.
129
- # @return [Integer]
130
- class DescribeAffectedEntitiesRequest < Struct.new(
131
- :filter,
132
- :locale,
133
- :next_token,
134
- :max_results)
135
- include Aws::Structure
136
- end
58
+ # A range of dates and times that is used by the EventFilter and
59
+ # EntityFilter objects. If `from` is set and `to` is set: match items
60
+ # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) is
61
+ # between `from` and `to` inclusive. If `from` is set and `to` is not
62
+ # set: match items where the timestamp value is equal to or after
63
+ # `from`. If `from` is not set and `to` is set: match items where the
64
+ # timestamp value is equal to or before `to`.
65
+ #
66
+ # @note When making an API call, you may pass DateTimeRange
67
+ # data as a hash:
68
+ #
69
+ # {
70
+ # from: Time.now,
71
+ # to: Time.now,
72
+ # }
73
+ #
74
+ # @!attribute [rw] from
75
+ # The starting date and time of a time range.
76
+ # @return [Time]
77
+ #
78
+ # @!attribute [rw] to
79
+ # The ending date and time of a time range.
80
+ # @return [Time]
81
+ #
82
+ class DateTimeRange < Struct.new(
83
+ :from,
84
+ :to)
85
+ include Aws::Structure
86
+ end
137
87
 
138
- # @!attribute [rw] entities
139
- # The entities that match the filter criteria.
140
- # @return [Array<Types::AffectedEntity>]
141
- #
142
- # @!attribute [rw] next_token
143
- # If the results of a search are large, only a portion of the results
144
- # are returned, and a `nextToken` pagination token is returned in the
145
- # response. To retrieve the next batch of results, reissue the search
146
- # request and include the returned token. When all results have been
147
- # returned, the response does not contain a pagination token value.
148
- # @return [String]
149
- class DescribeAffectedEntitiesResponse < Struct.new(
150
- :entities,
151
- :next_token)
152
- include Aws::Structure
153
- end
88
+ # @note When making an API call, you may pass DescribeAffectedEntitiesRequest
89
+ # data as a hash:
90
+ #
91
+ # {
92
+ # filter: { # required
93
+ # event_arns: ["eventArn"], # required
94
+ # entity_arns: ["entityArn"],
95
+ # entity_values: ["entityValue"],
96
+ # last_updated_times: [
97
+ # {
98
+ # from: Time.now,
99
+ # to: Time.now,
100
+ # },
101
+ # ],
102
+ # tags: [
103
+ # {
104
+ # "tagKey" => "tagValue",
105
+ # },
106
+ # ],
107
+ # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
108
+ # },
109
+ # locale: "locale",
110
+ # next_token: "nextToken",
111
+ # max_results: 1,
112
+ # }
113
+ #
114
+ # @!attribute [rw] filter
115
+ # Values to narrow the results returned. At least one event ARN is
116
+ # required.
117
+ # @return [Types::EntityFilter]
118
+ #
119
+ # @!attribute [rw] locale
120
+ # The locale (language) to return information in. English (en) is the
121
+ # default and the only supported value at this time.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] next_token
125
+ # If the results of a search are large, only a portion of the results
126
+ # are returned, and a `nextToken` pagination token is returned in the
127
+ # response. To retrieve the next batch of results, reissue the search
128
+ # request and include the returned token. When all results have been
129
+ # returned, the response does not contain a pagination token value.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] max_results
133
+ # The maximum number of items to return in one batch, between 10 and
134
+ # 100, inclusive.
135
+ # @return [Integer]
136
+ #
137
+ class DescribeAffectedEntitiesRequest < Struct.new(
138
+ :filter,
139
+ :locale,
140
+ :next_token,
141
+ :max_results)
142
+ include Aws::Structure
143
+ end
154
144
 
155
- # @note When making an API call, pass DescribeEntityAggregatesRequest
156
- # data as a hash:
157
- #
158
- # {
159
- # event_arns: ["eventArn"],
160
- # }
161
- # @!attribute [rw] event_arns
162
- # A list of event ARNs (unique identifiers). For example:
163
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
164
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
165
- # @return [Array<String>]
166
- class DescribeEntityAggregatesRequest < Struct.new(
167
- :event_arns)
168
- include Aws::Structure
169
- end
145
+ # @!attribute [rw] entities
146
+ # The entities that match the filter criteria.
147
+ # @return [Array<Types::AffectedEntity>]
148
+ #
149
+ # @!attribute [rw] next_token
150
+ # If the results of a search are large, only a portion of the results
151
+ # are returned, and a `nextToken` pagination token is returned in the
152
+ # response. To retrieve the next batch of results, reissue the search
153
+ # request and include the returned token. When all results have been
154
+ # returned, the response does not contain a pagination token value.
155
+ # @return [String]
156
+ #
157
+ class DescribeAffectedEntitiesResponse < Struct.new(
158
+ :entities,
159
+ :next_token)
160
+ include Aws::Structure
161
+ end
170
162
 
171
- # @!attribute [rw] entity_aggregates
172
- # The number of entities that are affected by each of the specified
173
- # events.
174
- # @return [Array<Types::EntityAggregate>]
175
- class DescribeEntityAggregatesResponse < Struct.new(
176
- :entity_aggregates)
177
- include Aws::Structure
178
- end
163
+ # @note When making an API call, you may pass DescribeEntityAggregatesRequest
164
+ # data as a hash:
165
+ #
166
+ # {
167
+ # event_arns: ["eventArn"],
168
+ # }
169
+ #
170
+ # @!attribute [rw] event_arns
171
+ # A list of event ARNs (unique identifiers). For example:
172
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
173
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
174
+ # @return [Array<String>]
175
+ #
176
+ class DescribeEntityAggregatesRequest < Struct.new(
177
+ :event_arns)
178
+ include Aws::Structure
179
+ end
179
180
 
180
- # @note When making an API call, pass DescribeEventAggregatesRequest
181
- # data as a hash:
182
- #
183
- # {
184
- # filter: {
185
- # event_arns: ["eventArn"],
186
- # event_type_codes: ["eventType"],
187
- # services: ["service"],
188
- # regions: ["region"],
189
- # availability_zones: ["availabilityZone"],
190
- # start_times: [
191
- # {
192
- # from: Time.now,
193
- # to: Time.now,
194
- # },
195
- # ],
196
- # end_times: [
197
- # {
198
- # from: Time.now,
199
- # to: Time.now,
200
- # },
201
- # ],
202
- # last_updated_times: [
203
- # {
204
- # from: Time.now,
205
- # to: Time.now,
206
- # },
207
- # ],
208
- # entity_arns: ["entityArn"],
209
- # entity_values: ["entityValue"],
210
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
211
- # tags: [
212
- # {
213
- # "tagKey" => "tagValue",
214
- # },
215
- # ],
216
- # event_status_codes: ["open"], # accepts open, closed, upcoming
217
- # },
218
- # aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
219
- # max_results: 1,
220
- # next_token: "nextToken",
221
- # }
222
- # @!attribute [rw] filter
223
- # Values to narrow the results returned.
224
- # @return [Types::EventFilter]
225
- #
226
- # @!attribute [rw] aggregate_field
227
- # The only currently supported value is `eventTypeCategory`.
228
- # @return [String]
229
- #
230
- # @!attribute [rw] max_results
231
- # The maximum number of items to return in one batch.
232
- # @return [Integer]
233
- #
234
- # @!attribute [rw] next_token
235
- # If the results of a search are large, only a portion of the results
236
- # are returned, and a `nextToken` pagination token is returned in the
237
- # response. To retrieve the next batch of results, reissue the search
238
- # request and include the returned token. When all results have been
239
- # returned, the response does not contain a pagination token value.
240
- # @return [String]
241
- class DescribeEventAggregatesRequest < Struct.new(
242
- :filter,
243
- :aggregate_field,
244
- :max_results,
245
- :next_token)
246
- include Aws::Structure
247
- end
181
+ # @!attribute [rw] entity_aggregates
182
+ # The number of entities that are affected by each of the specified
183
+ # events.
184
+ # @return [Array<Types::EntityAggregate>]
185
+ #
186
+ class DescribeEntityAggregatesResponse < Struct.new(
187
+ :entity_aggregates)
188
+ include Aws::Structure
189
+ end
248
190
 
249
- # @!attribute [rw] event_aggregates
250
- # The number of events in each category that meet the optional filter
251
- # criteria.
252
- # @return [Array<Types::EventAggregate>]
253
- #
254
- # @!attribute [rw] next_token
255
- # If the results of a search are large, only a portion of the results
256
- # are returned, and a `nextToken` pagination token is returned in the
257
- # response. To retrieve the next batch of results, reissue the search
258
- # request and include the returned token. When all results have been
259
- # returned, the response does not contain a pagination token value.
260
- # @return [String]
261
- class DescribeEventAggregatesResponse < Struct.new(
262
- :event_aggregates,
263
- :next_token)
264
- include Aws::Structure
265
- end
191
+ # @note When making an API call, you may pass DescribeEventAggregatesRequest
192
+ # data as a hash:
193
+ #
194
+ # {
195
+ # filter: {
196
+ # event_arns: ["eventArn"],
197
+ # event_type_codes: ["eventType"],
198
+ # services: ["service"],
199
+ # regions: ["region"],
200
+ # availability_zones: ["availabilityZone"],
201
+ # start_times: [
202
+ # {
203
+ # from: Time.now,
204
+ # to: Time.now,
205
+ # },
206
+ # ],
207
+ # end_times: [
208
+ # {
209
+ # from: Time.now,
210
+ # to: Time.now,
211
+ # },
212
+ # ],
213
+ # last_updated_times: [
214
+ # {
215
+ # from: Time.now,
216
+ # to: Time.now,
217
+ # },
218
+ # ],
219
+ # entity_arns: ["entityArn"],
220
+ # entity_values: ["entityValue"],
221
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
222
+ # tags: [
223
+ # {
224
+ # "tagKey" => "tagValue",
225
+ # },
226
+ # ],
227
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
228
+ # },
229
+ # aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
230
+ # max_results: 1,
231
+ # next_token: "nextToken",
232
+ # }
233
+ #
234
+ # @!attribute [rw] filter
235
+ # Values to narrow the results returned.
236
+ # @return [Types::EventFilter]
237
+ #
238
+ # @!attribute [rw] aggregate_field
239
+ # The only currently supported value is `eventTypeCategory`.
240
+ # @return [String]
241
+ #
242
+ # @!attribute [rw] max_results
243
+ # The maximum number of items to return in one batch, between 10 and
244
+ # 100, inclusive.
245
+ # @return [Integer]
246
+ #
247
+ # @!attribute [rw] next_token
248
+ # If the results of a search are large, only a portion of the results
249
+ # are returned, and a `nextToken` pagination token is returned in the
250
+ # response. To retrieve the next batch of results, reissue the search
251
+ # request and include the returned token. When all results have been
252
+ # returned, the response does not contain a pagination token value.
253
+ # @return [String]
254
+ #
255
+ class DescribeEventAggregatesRequest < Struct.new(
256
+ :filter,
257
+ :aggregate_field,
258
+ :max_results,
259
+ :next_token)
260
+ include Aws::Structure
261
+ end
266
262
 
267
- # @note When making an API call, pass DescribeEventDetailsRequest
268
- # data as a hash:
269
- #
270
- # {
271
- # event_arns: ["eventArn"], # required
272
- # locale: "locale",
273
- # }
274
- # @!attribute [rw] event_arns
275
- # A list of event ARNs (unique identifiers). For example:
276
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
277
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
278
- # @return [Array<String>]
279
- #
280
- # @!attribute [rw] locale
281
- # The locale (language) to return information in. The default is
282
- # English.
283
- # @return [String]
284
- class DescribeEventDetailsRequest < Struct.new(
285
- :event_arns,
286
- :locale)
287
- include Aws::Structure
288
- end
263
+ # @!attribute [rw] event_aggregates
264
+ # The number of events in each category that meet the optional filter
265
+ # criteria.
266
+ # @return [Array<Types::EventAggregate>]
267
+ #
268
+ # @!attribute [rw] next_token
269
+ # If the results of a search are large, only a portion of the results
270
+ # are returned, and a `nextToken` pagination token is returned in the
271
+ # response. To retrieve the next batch of results, reissue the search
272
+ # request and include the returned token. When all results have been
273
+ # returned, the response does not contain a pagination token value.
274
+ # @return [String]
275
+ #
276
+ class DescribeEventAggregatesResponse < Struct.new(
277
+ :event_aggregates,
278
+ :next_token)
279
+ include Aws::Structure
280
+ end
289
281
 
290
- # @!attribute [rw] successful_set
291
- # Information about the events that could be retrieved.
292
- # @return [Array<Types::EventDetails>]
293
- #
294
- # @!attribute [rw] failed_set
295
- # Error messages for any events that could not be retrieved.
296
- # @return [Array<Types::EventDetailsErrorItem>]
297
- class DescribeEventDetailsResponse < Struct.new(
298
- :successful_set,
299
- :failed_set)
300
- include Aws::Structure
301
- end
282
+ # @note When making an API call, you may pass DescribeEventDetailsRequest
283
+ # data as a hash:
284
+ #
285
+ # {
286
+ # event_arns: ["eventArn"], # required
287
+ # locale: "locale",
288
+ # }
289
+ #
290
+ # @!attribute [rw] event_arns
291
+ # A list of event ARNs (unique identifiers). For example:
292
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
293
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
294
+ # @return [Array<String>]
295
+ #
296
+ # @!attribute [rw] locale
297
+ # The locale (language) to return information in. English (en) is the
298
+ # default and the only supported value at this time.
299
+ # @return [String]
300
+ #
301
+ class DescribeEventDetailsRequest < Struct.new(
302
+ :event_arns,
303
+ :locale)
304
+ include Aws::Structure
305
+ end
302
306
 
303
- # @note When making an API call, pass DescribeEventTypesRequest
304
- # data as a hash:
305
- #
306
- # {
307
- # filter: {
308
- # event_type_codes: ["eventTypeCode"],
309
- # services: ["service"],
310
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
311
- # },
312
- # locale: "locale",
313
- # next_token: "nextToken",
314
- # max_results: 1,
315
- # }
316
- # @!attribute [rw] filter
317
- # Values to narrow the results returned.
318
- # @return [Types::EventTypeFilter]
319
- #
320
- # @!attribute [rw] locale
321
- # The locale (language) to return information in. The default is
322
- # English.
323
- # @return [String]
324
- #
325
- # @!attribute [rw] next_token
326
- # If the results of a search are large, only a portion of the results
327
- # are returned, and a `nextToken` pagination token is returned in the
328
- # response. To retrieve the next batch of results, reissue the search
329
- # request and include the returned token. When all results have been
330
- # returned, the response does not contain a pagination token value.
331
- # @return [String]
332
- #
333
- # @!attribute [rw] max_results
334
- # The maximum number of items to return in one batch.
335
- # @return [Integer]
336
- class DescribeEventTypesRequest < Struct.new(
337
- :filter,
338
- :locale,
339
- :next_token,
340
- :max_results)
341
- include Aws::Structure
342
- end
307
+ # @!attribute [rw] successful_set
308
+ # Information about the events that could be retrieved.
309
+ # @return [Array<Types::EventDetails>]
310
+ #
311
+ # @!attribute [rw] failed_set
312
+ # Error messages for any events that could not be retrieved.
313
+ # @return [Array<Types::EventDetailsErrorItem>]
314
+ #
315
+ class DescribeEventDetailsResponse < Struct.new(
316
+ :successful_set,
317
+ :failed_set)
318
+ include Aws::Structure
319
+ end
343
320
 
344
- # @!attribute [rw] event_types
345
- # List of event types to be matched with.
346
- # @return [Array<Types::EventType>]
347
- #
348
- # @!attribute [rw] next_token
349
- # If the results of a search are large, only a portion of the results
350
- # are returned, and a `nextToken` pagination token is returned in the
351
- # response. To retrieve the next batch of results, reissue the search
352
- # request and include the returned token. When all results have been
353
- # returned, the response does not contain a pagination token value.
354
- # @return [String]
355
- class DescribeEventTypesResponse < Struct.new(
356
- :event_types,
357
- :next_token)
358
- include Aws::Structure
359
- end
321
+ # @note When making an API call, you may pass DescribeEventTypesRequest
322
+ # data as a hash:
323
+ #
324
+ # {
325
+ # filter: {
326
+ # event_type_codes: ["eventTypeCode"],
327
+ # services: ["service"],
328
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
329
+ # },
330
+ # locale: "locale",
331
+ # next_token: "nextToken",
332
+ # max_results: 1,
333
+ # }
334
+ #
335
+ # @!attribute [rw] filter
336
+ # Values to narrow the results returned.
337
+ # @return [Types::EventTypeFilter]
338
+ #
339
+ # @!attribute [rw] locale
340
+ # The locale (language) to return information in. English (en) is the
341
+ # default and the only supported value at this time.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] next_token
345
+ # If the results of a search are large, only a portion of the results
346
+ # are returned, and a `nextToken` pagination token is returned in the
347
+ # response. To retrieve the next batch of results, reissue the search
348
+ # request and include the returned token. When all results have been
349
+ # returned, the response does not contain a pagination token value.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] max_results
353
+ # The maximum number of items to return in one batch, between 10 and
354
+ # 100, inclusive.
355
+ # @return [Integer]
356
+ #
357
+ class DescribeEventTypesRequest < Struct.new(
358
+ :filter,
359
+ :locale,
360
+ :next_token,
361
+ :max_results)
362
+ include Aws::Structure
363
+ end
360
364
 
361
- # @note When making an API call, pass DescribeEventsRequest
362
- # data as a hash:
363
- #
364
- # {
365
- # filter: {
366
- # event_arns: ["eventArn"],
367
- # event_type_codes: ["eventType"],
368
- # services: ["service"],
369
- # regions: ["region"],
370
- # availability_zones: ["availabilityZone"],
371
- # start_times: [
372
- # {
373
- # from: Time.now,
374
- # to: Time.now,
375
- # },
376
- # ],
377
- # end_times: [
378
- # {
379
- # from: Time.now,
380
- # to: Time.now,
381
- # },
382
- # ],
383
- # last_updated_times: [
384
- # {
385
- # from: Time.now,
386
- # to: Time.now,
387
- # },
388
- # ],
389
- # entity_arns: ["entityArn"],
390
- # entity_values: ["entityValue"],
391
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
392
- # tags: [
393
- # {
394
- # "tagKey" => "tagValue",
395
- # },
396
- # ],
397
- # event_status_codes: ["open"], # accepts open, closed, upcoming
398
- # },
399
- # next_token: "nextToken",
400
- # max_results: 1,
401
- # locale: "locale",
402
- # }
403
- # @!attribute [rw] filter
404
- # Values to narrow the results returned.
405
- # @return [Types::EventFilter]
406
- #
407
- # @!attribute [rw] next_token
408
- # If the results of a search are large, only a portion of the results
409
- # are returned, and a `nextToken` pagination token is returned in the
410
- # response. To retrieve the next batch of results, reissue the search
411
- # request and include the returned token. When all results have been
412
- # returned, the response does not contain a pagination token value.
413
- # @return [String]
414
- #
415
- # @!attribute [rw] max_results
416
- # The maximum number of items to return in one batch.
417
- # @return [Integer]
418
- #
419
- # @!attribute [rw] locale
420
- # The locale (language) to return information in. The default is
421
- # English.
422
- # @return [String]
423
- class DescribeEventsRequest < Struct.new(
424
- :filter,
425
- :next_token,
426
- :max_results,
427
- :locale)
428
- include Aws::Structure
429
- end
365
+ # @!attribute [rw] event_types
366
+ # A list of event types that match the filter criteria. Event types
367
+ # have a category (`issue`, `accountNotification`, or
368
+ # `scheduledChange`), a service (for example, `EC2`, `RDS`,
369
+ # `DATAPIPELINE`, `BILLING`), and a code (in the format
370
+ # `AWS_SERVICE_DESCRIPTION `; for example,
371
+ # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`).
372
+ # @return [Array<Types::EventType>]
373
+ #
374
+ # @!attribute [rw] next_token
375
+ # If the results of a search are large, only a portion of the results
376
+ # are returned, and a `nextToken` pagination token is returned in the
377
+ # response. To retrieve the next batch of results, reissue the search
378
+ # request and include the returned token. When all results have been
379
+ # returned, the response does not contain a pagination token value.
380
+ # @return [String]
381
+ #
382
+ class DescribeEventTypesResponse < Struct.new(
383
+ :event_types,
384
+ :next_token)
385
+ include Aws::Structure
386
+ end
430
387
 
431
- # @!attribute [rw] events
432
- # The events that match the specified filter criteria.
433
- # @return [Array<Types::Event>]
434
- #
435
- # @!attribute [rw] next_token
436
- # If the results of a search are large, only a portion of the results
437
- # are returned, and a `nextToken` pagination token is returned in the
438
- # response. To retrieve the next batch of results, reissue the search
439
- # request and include the returned token. When all results have been
440
- # returned, the response does not contain a pagination token value.
441
- # @return [String]
442
- class DescribeEventsResponse < Struct.new(
443
- :events,
444
- :next_token)
445
- include Aws::Structure
446
- end
388
+ # @note When making an API call, you may pass DescribeEventsRequest
389
+ # data as a hash:
390
+ #
391
+ # {
392
+ # filter: {
393
+ # event_arns: ["eventArn"],
394
+ # event_type_codes: ["eventType"],
395
+ # services: ["service"],
396
+ # regions: ["region"],
397
+ # availability_zones: ["availabilityZone"],
398
+ # start_times: [
399
+ # {
400
+ # from: Time.now,
401
+ # to: Time.now,
402
+ # },
403
+ # ],
404
+ # end_times: [
405
+ # {
406
+ # from: Time.now,
407
+ # to: Time.now,
408
+ # },
409
+ # ],
410
+ # last_updated_times: [
411
+ # {
412
+ # from: Time.now,
413
+ # to: Time.now,
414
+ # },
415
+ # ],
416
+ # entity_arns: ["entityArn"],
417
+ # entity_values: ["entityValue"],
418
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
419
+ # tags: [
420
+ # {
421
+ # "tagKey" => "tagValue",
422
+ # },
423
+ # ],
424
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
425
+ # },
426
+ # next_token: "nextToken",
427
+ # max_results: 1,
428
+ # locale: "locale",
429
+ # }
430
+ #
431
+ # @!attribute [rw] filter
432
+ # Values to narrow the results returned.
433
+ # @return [Types::EventFilter]
434
+ #
435
+ # @!attribute [rw] next_token
436
+ # If the results of a search are large, only a portion of the results
437
+ # are returned, and a `nextToken` pagination token is returned in the
438
+ # response. To retrieve the next batch of results, reissue the search
439
+ # request and include the returned token. When all results have been
440
+ # returned, the response does not contain a pagination token value.
441
+ # @return [String]
442
+ #
443
+ # @!attribute [rw] max_results
444
+ # The maximum number of items to return in one batch, between 10 and
445
+ # 100, inclusive.
446
+ # @return [Integer]
447
+ #
448
+ # @!attribute [rw] locale
449
+ # The locale (language) to return information in. English (en) is the
450
+ # default and the only supported value at this time.
451
+ # @return [String]
452
+ #
453
+ class DescribeEventsRequest < Struct.new(
454
+ :filter,
455
+ :next_token,
456
+ :max_results,
457
+ :locale)
458
+ include Aws::Structure
459
+ end
447
460
 
448
- # The number of entities that are affected by one or more events.
449
- # Returned by the DescribeEntityAggregates operation.
450
- # @!attribute [rw] event_arn
451
- # The unique identifier for the event. Format:
452
- # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
453
- # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
454
- # @return [String]
455
- #
456
- # @!attribute [rw] count
457
- # The number entities that match the criteria for the specified
458
- # events.
459
- # @return [Integer]
460
- class EntityAggregate < Struct.new(
461
- :event_arn,
462
- :count)
463
- include Aws::Structure
464
- end
461
+ # @!attribute [rw] events
462
+ # The events that match the specified filter criteria.
463
+ # @return [Array<Types::Event>]
464
+ #
465
+ # @!attribute [rw] next_token
466
+ # If the results of a search are large, only a portion of the results
467
+ # are returned, and a `nextToken` pagination token is returned in the
468
+ # response. To retrieve the next batch of results, reissue the search
469
+ # request and include the returned token. When all results have been
470
+ # returned, the response does not contain a pagination token value.
471
+ # @return [String]
472
+ #
473
+ class DescribeEventsResponse < Struct.new(
474
+ :events,
475
+ :next_token)
476
+ include Aws::Structure
477
+ end
465
478
 
466
- # The values to use to filter results from the DescribeAffectedEntities
467
- # operation.
468
- # @note When making an API call, pass EntityFilter
469
- # data as a hash:
470
- #
471
- # {
472
- # event_arns: ["eventArn"], # required
473
- # entity_arns: ["entityArn"],
474
- # entity_values: ["entityValue"],
475
- # last_updated_times: [
476
- # {
477
- # from: Time.now,
478
- # to: Time.now,
479
- # },
480
- # ],
481
- # tags: [
482
- # {
483
- # "tagKey" => "tagValue",
484
- # },
485
- # ],
486
- # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
487
- # }
488
- # @!attribute [rw] event_arns
489
- # A list of event ARNs (unique identifiers). For example:
490
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
491
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
492
- # @return [Array<String>]
493
- #
494
- # @!attribute [rw] entity_arns
495
- # A list of entity ARNs (unique identifiers).
496
- # @return [Array<String>]
497
- #
498
- # @!attribute [rw] entity_values
499
- # A list of IDs for affected entities.
500
- # @return [Array<String>]
501
- #
502
- # @!attribute [rw] last_updated_times
503
- # A list of the most recent dates and times that the entity was
504
- # updated.
505
- # @return [Array<Types::DateTimeRange>]
506
- #
507
- # @!attribute [rw] tags
508
- # A map of entity tags attached to the affected entity.
509
- # @return [Array<Hash<String,String>>]
510
- #
511
- # @!attribute [rw] status_codes
512
- # A list of entity status codes (`IMPAIRED`, `UNIMPAIRED`, or
513
- # `UNKNOWN`).
514
- # @return [Array<String>]
515
- class EntityFilter < Struct.new(
516
- :event_arns,
517
- :entity_arns,
518
- :entity_values,
519
- :last_updated_times,
520
- :tags,
521
- :status_codes)
522
- include Aws::Structure
523
- end
479
+ # The number of entities that are affected by one or more events.
480
+ # Returned by the DescribeEntityAggregates operation.
481
+ #
482
+ # @!attribute [rw] event_arn
483
+ # The unique identifier for the event. Format:
484
+ # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
485
+ # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] count
489
+ # The number entities that match the criteria for the specified
490
+ # events.
491
+ # @return [Integer]
492
+ #
493
+ class EntityAggregate < Struct.new(
494
+ :event_arn,
495
+ :count)
496
+ include Aws::Structure
497
+ end
524
498
 
525
- # Summary information about an event, returned by the DescribeEvents
526
- # operation. The DescribeEventDetails operation also returns this
527
- # information, as well as the EventDescription and additional event
528
- # metadata.
529
- # @!attribute [rw] arn
530
- # The unique identifier for the event. Format:
531
- # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
532
- # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
533
- # @return [String]
534
- #
535
- # @!attribute [rw] service
536
- # The AWS service that is affected by the event. For example, `EC2`,
537
- # `RDS`.
538
- # @return [String]
539
- #
540
- # @!attribute [rw] event_type_code
541
- # The unique identifier for the event type. The format is
542
- # `AWS_SERVICE_DESCRIPTION `; for example,
543
- # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
544
- # @return [String]
545
- #
546
- # @!attribute [rw] event_type_category
547
- # The
548
- # @return [String]
549
- #
550
- # @!attribute [rw] region
551
- # The AWS region name of the event.
552
- # @return [String]
553
- #
554
- # @!attribute [rw] availability_zone
555
- # The AWS Availability Zone of the event. For example, us-east-1a.
556
- # @return [String]
557
- #
558
- # @!attribute [rw] start_time
559
- # The date and time that the event began.
560
- # @return [Time]
561
- #
562
- # @!attribute [rw] end_time
563
- # The date and time that the event ended.
564
- # @return [Time]
565
- #
566
- # @!attribute [rw] last_updated_time
567
- # The most recent date and time that the event was updated.
568
- # @return [Time]
569
- #
570
- # @!attribute [rw] status_code
571
- # The most recent status of the event. Possible values are `open`,
572
- # `closed`, and `upcoming`.
573
- # @return [String]
574
- class Event < Struct.new(
575
- :arn,
576
- :service,
577
- :event_type_code,
578
- :event_type_category,
579
- :region,
580
- :availability_zone,
581
- :start_time,
582
- :end_time,
583
- :last_updated_time,
584
- :status_code)
585
- include Aws::Structure
586
- end
499
+ # The values to use to filter results from the DescribeAffectedEntities
500
+ # operation.
501
+ #
502
+ # @note When making an API call, you may pass EntityFilter
503
+ # data as a hash:
504
+ #
505
+ # {
506
+ # event_arns: ["eventArn"], # required
507
+ # entity_arns: ["entityArn"],
508
+ # entity_values: ["entityValue"],
509
+ # last_updated_times: [
510
+ # {
511
+ # from: Time.now,
512
+ # to: Time.now,
513
+ # },
514
+ # ],
515
+ # tags: [
516
+ # {
517
+ # "tagKey" => "tagValue",
518
+ # },
519
+ # ],
520
+ # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
521
+ # }
522
+ #
523
+ # @!attribute [rw] event_arns
524
+ # A list of event ARNs (unique identifiers). For example:
525
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
526
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
527
+ # @return [Array<String>]
528
+ #
529
+ # @!attribute [rw] entity_arns
530
+ # A list of entity ARNs (unique identifiers).
531
+ # @return [Array<String>]
532
+ #
533
+ # @!attribute [rw] entity_values
534
+ # A list of IDs for affected entities.
535
+ # @return [Array<String>]
536
+ #
537
+ # @!attribute [rw] last_updated_times
538
+ # A list of the most recent dates and times that the entity was
539
+ # updated.
540
+ # @return [Array<Types::DateTimeRange>]
541
+ #
542
+ # @!attribute [rw] tags
543
+ # A map of entity tags attached to the affected entity.
544
+ # @return [Array<Hash<String,String>>]
545
+ #
546
+ # @!attribute [rw] status_codes
547
+ # A list of entity status codes (`IMPAIRED`, `UNIMPAIRED`, or
548
+ # `UNKNOWN`).
549
+ # @return [Array<String>]
550
+ #
551
+ class EntityFilter < Struct.new(
552
+ :event_arns,
553
+ :entity_arns,
554
+ :entity_values,
555
+ :last_updated_times,
556
+ :tags,
557
+ :status_codes)
558
+ include Aws::Structure
559
+ end
587
560
 
588
- # The number of events of each issue type. Returned by the
589
- # DescribeEventAggregates operation.
590
- # @!attribute [rw] aggregate_value
591
- # The issue type for the associated count.
592
- # @return [String]
593
- #
594
- # @!attribute [rw] count
595
- # The number of events of the associated issue type.
596
- # @return [Integer]
597
- class EventAggregate < Struct.new(
598
- :aggregate_value,
599
- :count)
600
- include Aws::Structure
601
- end
561
+ # Summary information about an event, returned by the DescribeEvents
562
+ # operation. The DescribeEventDetails operation also returns this
563
+ # information, as well as the EventDescription and additional event
564
+ # metadata.
565
+ #
566
+ # @!attribute [rw] arn
567
+ # The unique identifier for the event. Format:
568
+ # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
569
+ # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] service
573
+ # The AWS service that is affected by the event. For example, `EC2`,
574
+ # `RDS`.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] event_type_code
578
+ # The unique identifier for the event type. The format is
579
+ # `AWS_SERVICE_DESCRIPTION `; for example,
580
+ # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
581
+ # @return [String]
582
+ #
583
+ # @!attribute [rw] event_type_category
584
+ # The
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] region
588
+ # The AWS region name of the event.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] availability_zone
592
+ # The AWS Availability Zone of the event. For example, us-east-1a.
593
+ # @return [String]
594
+ #
595
+ # @!attribute [rw] start_time
596
+ # The date and time that the event began.
597
+ # @return [Time]
598
+ #
599
+ # @!attribute [rw] end_time
600
+ # The date and time that the event ended.
601
+ # @return [Time]
602
+ #
603
+ # @!attribute [rw] last_updated_time
604
+ # The most recent date and time that the event was updated.
605
+ # @return [Time]
606
+ #
607
+ # @!attribute [rw] status_code
608
+ # The most recent status of the event. Possible values are `open`,
609
+ # `closed`, and `upcoming`.
610
+ # @return [String]
611
+ #
612
+ class Event < Struct.new(
613
+ :arn,
614
+ :service,
615
+ :event_type_code,
616
+ :event_type_category,
617
+ :region,
618
+ :availability_zone,
619
+ :start_time,
620
+ :end_time,
621
+ :last_updated_time,
622
+ :status_code)
623
+ include Aws::Structure
624
+ end
602
625
 
603
- # The detailed description of the event. Included in the information
604
- # returned by the DescribeEventDetails operation.
605
- # @!attribute [rw] latest_description
606
- # The most recent description of the event.
607
- # @return [String]
608
- class EventDescription < Struct.new(
609
- :latest_description)
610
- include Aws::Structure
611
- end
626
+ # The number of events of each issue type. Returned by the
627
+ # DescribeEventAggregates operation.
628
+ #
629
+ # @!attribute [rw] aggregate_value
630
+ # The issue type for the associated count.
631
+ # @return [String]
632
+ #
633
+ # @!attribute [rw] count
634
+ # The number of events of the associated issue type.
635
+ # @return [Integer]
636
+ #
637
+ class EventAggregate < Struct.new(
638
+ :aggregate_value,
639
+ :count)
640
+ include Aws::Structure
641
+ end
612
642
 
613
- # Detailed information about an event. A combination of an Event object,
614
- # an EventDescription object, and additional metadata about the event.
615
- # Returned by the DescribeEventDetails operation.
616
- # @!attribute [rw] event
617
- # Summary information about the event.
618
- # @return [Types::Event]
619
- #
620
- # @!attribute [rw] event_description
621
- # The most recent description of the event.
622
- # @return [Types::EventDescription]
623
- #
624
- # @!attribute [rw] event_metadata
625
- # Additional metadata about the event.
626
- # @return [Hash<String,String>]
627
- class EventDetails < Struct.new(
628
- :event,
629
- :event_description,
630
- :event_metadata)
631
- include Aws::Structure
632
- end
643
+ # The detailed description of the event. Included in the information
644
+ # returned by the DescribeEventDetails operation.
645
+ #
646
+ # @!attribute [rw] latest_description
647
+ # The most recent description of the event.
648
+ # @return [String]
649
+ #
650
+ class EventDescription < Struct.new(
651
+ :latest_description)
652
+ include Aws::Structure
653
+ end
633
654
 
634
- # Error information returned when a DescribeEventDetails operation
635
- # cannot find a specified event.
636
- # @!attribute [rw] event_arn
637
- # The unique identifier for the event. Format:
638
- # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
639
- # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
640
- # @return [String]
641
- #
642
- # @!attribute [rw] error_name
643
- # The name of the error.
644
- # @return [String]
645
- #
646
- # @!attribute [rw] error_message
647
- # A message that describes the error.
648
- # @return [String]
649
- class EventDetailsErrorItem < Struct.new(
650
- :event_arn,
651
- :error_name,
652
- :error_message)
653
- include Aws::Structure
654
- end
655
+ # Detailed information about an event. A combination of an Event object,
656
+ # an EventDescription object, and additional metadata about the event.
657
+ # Returned by the DescribeEventDetails operation.
658
+ #
659
+ # @!attribute [rw] event
660
+ # Summary information about the event.
661
+ # @return [Types::Event]
662
+ #
663
+ # @!attribute [rw] event_description
664
+ # The most recent description of the event.
665
+ # @return [Types::EventDescription]
666
+ #
667
+ # @!attribute [rw] event_metadata
668
+ # Additional metadata about the event.
669
+ # @return [Hash<String,String>]
670
+ #
671
+ class EventDetails < Struct.new(
672
+ :event,
673
+ :event_description,
674
+ :event_metadata)
675
+ include Aws::Structure
676
+ end
655
677
 
656
- # The values to use to filter results from the DescribeEvents and
657
- # DescribeEventAggregates operations.
658
- # @note When making an API call, pass EventFilter
659
- # data as a hash:
660
- #
661
- # {
662
- # event_arns: ["eventArn"],
663
- # event_type_codes: ["eventType"],
664
- # services: ["service"],
665
- # regions: ["region"],
666
- # availability_zones: ["availabilityZone"],
667
- # start_times: [
668
- # {
669
- # from: Time.now,
670
- # to: Time.now,
671
- # },
672
- # ],
673
- # end_times: [
674
- # {
675
- # from: Time.now,
676
- # to: Time.now,
677
- # },
678
- # ],
679
- # last_updated_times: [
680
- # {
681
- # from: Time.now,
682
- # to: Time.now,
683
- # },
684
- # ],
685
- # entity_arns: ["entityArn"],
686
- # entity_values: ["entityValue"],
687
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
688
- # tags: [
689
- # {
690
- # "tagKey" => "tagValue",
691
- # },
692
- # ],
693
- # event_status_codes: ["open"], # accepts open, closed, upcoming
694
- # }
695
- # @!attribute [rw] event_arns
696
- # A list of event ARNs (unique identifiers). For example:
697
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
698
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
699
- # @return [Array<String>]
700
- #
701
- # @!attribute [rw] event_type_codes
702
- # A list of unique identifiers for event types. For example,
703
- # `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"`
704
- # @return [Array<String>]
705
- #
706
- # @!attribute [rw] services
707
- # The AWS services associated with the event. For example, `EC2`,
708
- # `RDS`.
709
- # @return [Array<String>]
710
- #
711
- # @!attribute [rw] regions
712
- # A list of AWS regions.
713
- # @return [Array<String>]
714
- #
715
- # @!attribute [rw] availability_zones
716
- # A list of AWS availability zones.
717
- # @return [Array<String>]
718
- #
719
- # @!attribute [rw] start_times
720
- # A list of dates and times that the event began.
721
- # @return [Array<Types::DateTimeRange>]
722
- #
723
- # @!attribute [rw] end_times
724
- # A list of dates and times that the event ended.
725
- # @return [Array<Types::DateTimeRange>]
726
- #
727
- # @!attribute [rw] last_updated_times
728
- # A list of dates and times that the event was last updated.
729
- # @return [Array<Types::DateTimeRange>]
730
- #
731
- # @!attribute [rw] entity_arns
732
- # A list of entity ARNs (unique identifiers).
733
- # @return [Array<String>]
734
- #
735
- # @!attribute [rw] entity_values
736
- # A list of entity identifiers, such as EC2 instance IDs
737
- # (`i-34ab692e`) or EBS volumes (`vol-426ab23e`).
738
- # @return [Array<String>]
739
- #
740
- # @!attribute [rw] event_type_categories
741
- # A list of event type category codes (`issue`, `scheduledChange`, or
742
- # `accountNotification`).
743
- # @return [Array<String>]
744
- #
745
- # @!attribute [rw] tags
746
- # A map of entity tags attached to the affected entity.
747
- # @return [Array<Hash<String,String>>]
748
- #
749
- # @!attribute [rw] event_status_codes
750
- # A list of event status codes.
751
- # @return [Array<String>]
752
- class EventFilter < Struct.new(
753
- :event_arns,
754
- :event_type_codes,
755
- :services,
756
- :regions,
757
- :availability_zones,
758
- :start_times,
759
- :end_times,
760
- :last_updated_times,
761
- :entity_arns,
762
- :entity_values,
763
- :event_type_categories,
764
- :tags,
765
- :event_status_codes)
766
- include Aws::Structure
767
- end
678
+ # Error information returned when a DescribeEventDetails operation
679
+ # cannot find a specified event.
680
+ #
681
+ # @!attribute [rw] event_arn
682
+ # The unique identifier for the event. Format:
683
+ # `arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID `. Example:
684
+ # `arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331`
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] error_name
688
+ # The name of the error.
689
+ # @return [String]
690
+ #
691
+ # @!attribute [rw] error_message
692
+ # A message that describes the error.
693
+ # @return [String]
694
+ #
695
+ class EventDetailsErrorItem < Struct.new(
696
+ :event_arn,
697
+ :error_name,
698
+ :error_message)
699
+ include Aws::Structure
700
+ end
768
701
 
769
- # Metadata about a type of event that is reported by AWS Health. Data
770
- # consists of the category (for example, `issue`, the service (for
771
- # example, `EC2`), and the event type code (for example,
772
- # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`).
773
- # @!attribute [rw] service
774
- # The AWS service that is affected by the event. For example, `EC2`,
775
- # `RDS`.
776
- # @return [String]
777
- #
778
- # @!attribute [rw] code
779
- # The unique identifier for the event type. The format is
780
- # `AWS_SERVICE_DESCRIPTION `; for example,
781
- # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
782
- # @return [String]
783
- #
784
- # @!attribute [rw] category
785
- # A list of event type category codes (`issue`, `scheduledChange`, or
786
- # `accountNotification`).
787
- # @return [String]
788
- class EventType < Struct.new(
789
- :service,
790
- :code,
791
- :category)
792
- include Aws::Structure
793
- end
702
+ # The values to use to filter results from the DescribeEvents and
703
+ # DescribeEventAggregates operations.
704
+ #
705
+ # @note When making an API call, you may pass EventFilter
706
+ # data as a hash:
707
+ #
708
+ # {
709
+ # event_arns: ["eventArn"],
710
+ # event_type_codes: ["eventType"],
711
+ # services: ["service"],
712
+ # regions: ["region"],
713
+ # availability_zones: ["availabilityZone"],
714
+ # start_times: [
715
+ # {
716
+ # from: Time.now,
717
+ # to: Time.now,
718
+ # },
719
+ # ],
720
+ # end_times: [
721
+ # {
722
+ # from: Time.now,
723
+ # to: Time.now,
724
+ # },
725
+ # ],
726
+ # last_updated_times: [
727
+ # {
728
+ # from: Time.now,
729
+ # to: Time.now,
730
+ # },
731
+ # ],
732
+ # entity_arns: ["entityArn"],
733
+ # entity_values: ["entityValue"],
734
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
735
+ # tags: [
736
+ # {
737
+ # "tagKey" => "tagValue",
738
+ # },
739
+ # ],
740
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
741
+ # }
742
+ #
743
+ # @!attribute [rw] event_arns
744
+ # A list of event ARNs (unique identifiers). For example:
745
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
746
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
747
+ # @return [Array<String>]
748
+ #
749
+ # @!attribute [rw] event_type_codes
750
+ # A list of unique identifiers for event types. For example,
751
+ # `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"`
752
+ # @return [Array<String>]
753
+ #
754
+ # @!attribute [rw] services
755
+ # The AWS services associated with the event. For example, `EC2`,
756
+ # `RDS`.
757
+ # @return [Array<String>]
758
+ #
759
+ # @!attribute [rw] regions
760
+ # A list of AWS regions.
761
+ # @return [Array<String>]
762
+ #
763
+ # @!attribute [rw] availability_zones
764
+ # A list of AWS availability zones.
765
+ # @return [Array<String>]
766
+ #
767
+ # @!attribute [rw] start_times
768
+ # A list of dates and times that the event began.
769
+ # @return [Array<Types::DateTimeRange>]
770
+ #
771
+ # @!attribute [rw] end_times
772
+ # A list of dates and times that the event ended.
773
+ # @return [Array<Types::DateTimeRange>]
774
+ #
775
+ # @!attribute [rw] last_updated_times
776
+ # A list of dates and times that the event was last updated.
777
+ # @return [Array<Types::DateTimeRange>]
778
+ #
779
+ # @!attribute [rw] entity_arns
780
+ # A list of entity ARNs (unique identifiers).
781
+ # @return [Array<String>]
782
+ #
783
+ # @!attribute [rw] entity_values
784
+ # A list of entity identifiers, such as EC2 instance IDs
785
+ # (`i-34ab692e`) or EBS volumes (`vol-426ab23e`).
786
+ # @return [Array<String>]
787
+ #
788
+ # @!attribute [rw] event_type_categories
789
+ # A list of event type category codes (`issue`, `scheduledChange`, or
790
+ # `accountNotification`).
791
+ # @return [Array<String>]
792
+ #
793
+ # @!attribute [rw] tags
794
+ # A map of entity tags attached to the affected entity.
795
+ # @return [Array<Hash<String,String>>]
796
+ #
797
+ # @!attribute [rw] event_status_codes
798
+ # A list of event status codes.
799
+ # @return [Array<String>]
800
+ #
801
+ class EventFilter < Struct.new(
802
+ :event_arns,
803
+ :event_type_codes,
804
+ :services,
805
+ :regions,
806
+ :availability_zones,
807
+ :start_times,
808
+ :end_times,
809
+ :last_updated_times,
810
+ :entity_arns,
811
+ :entity_values,
812
+ :event_type_categories,
813
+ :tags,
814
+ :event_status_codes)
815
+ include Aws::Structure
816
+ end
794
817
 
795
- # The values to use to filter results from the DescribeEventTypes
796
- # operation.
797
- # @note When making an API call, pass EventTypeFilter
798
- # data as a hash:
799
- #
800
- # {
801
- # event_type_codes: ["eventTypeCode"],
802
- # services: ["service"],
803
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
804
- # }
805
- # @!attribute [rw] event_type_codes
806
- # A list of event type codes.
807
- # @return [Array<String>]
808
- #
809
- # @!attribute [rw] services
810
- # The AWS services associated with the event. For example, `EC2`,
811
- # `RDS`.
812
- # @return [Array<String>]
813
- #
814
- # @!attribute [rw] event_type_categories
815
- # A list of event type category codes (`issue`, `scheduledChange`, or
816
- # `accountNotification`).
817
- # @return [Array<String>]
818
- class EventTypeFilter < Struct.new(
819
- :event_type_codes,
820
- :services,
821
- :event_type_categories)
822
- include Aws::Structure
823
- end
818
+ # Metadata about a type of event that is reported by AWS Health. Data
819
+ # consists of the category (for example, `issue`), the service (for
820
+ # example, `EC2`), and the event type code (for example,
821
+ # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`).
822
+ #
823
+ # @!attribute [rw] service
824
+ # The AWS service that is affected by the event. For example, `EC2`,
825
+ # `RDS`.
826
+ # @return [String]
827
+ #
828
+ # @!attribute [rw] code
829
+ # The unique identifier for the event type. The format is
830
+ # `AWS_SERVICE_DESCRIPTION `; for example,
831
+ # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] category
835
+ # A list of event type category codes (`issue`, `scheduledChange`, or
836
+ # `accountNotification`).
837
+ # @return [String]
838
+ #
839
+ class EventType < Struct.new(
840
+ :service,
841
+ :code,
842
+ :category)
843
+ include Aws::Structure
844
+ end
824
845
 
846
+ # The values to use to filter results from the DescribeEventTypes
847
+ # operation.
848
+ #
849
+ # @note When making an API call, you may pass EventTypeFilter
850
+ # data as a hash:
851
+ #
852
+ # {
853
+ # event_type_codes: ["eventTypeCode"],
854
+ # services: ["service"],
855
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
856
+ # }
857
+ #
858
+ # @!attribute [rw] event_type_codes
859
+ # A list of event type codes.
860
+ # @return [Array<String>]
861
+ #
862
+ # @!attribute [rw] services
863
+ # The AWS services associated with the event. For example, `EC2`,
864
+ # `RDS`.
865
+ # @return [Array<String>]
866
+ #
867
+ # @!attribute [rw] event_type_categories
868
+ # A list of event type category codes (`issue`, `scheduledChange`, or
869
+ # `accountNotification`).
870
+ # @return [Array<String>]
871
+ #
872
+ class EventTypeFilter < Struct.new(
873
+ :event_type_codes,
874
+ :services,
875
+ :event_type_categories)
876
+ include Aws::Structure
825
877
  end
878
+
826
879
  end
827
880
  end