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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 5e4c747fa56738b6c6348f9e3592151a99e43946
4
- data.tar.gz: ca1a798e4c31c289040fddb81ad787ce6940481a
3
+ metadata.gz: 3343b1df0e2d4a0be2da5b1580d5a22e9298e8d0
4
+ data.tar.gz: 584c5d114b6114ff92d91828288439b1830ba3ab
5
5
  SHA512:
6
- metadata.gz: 1222fd1494e2d6d9ca49b1de0255df753194daf96aa00ecd059250c95e1c640c7860922524603f528ffa6b418198580e4de20a070cecc65a0b1396251f2f3770
7
- data.tar.gz: 0045ad4ebc27b365f22d15de631efddd4c4cd30770342017d8993978a08080692046e685d29bc6743105cf11fb190996e0cf6f7dfecf8b6edb57a907930181ee
6
+ metadata.gz: 1cf75d7a7b734b5a0fe1a5b465dcebd117f23099e02102878f835527be2ea555da4b7449b1cb236c1e820aa54f8e72f310a77defcda1bcfcec695958fbe9375c
7
+ data.tar.gz: 526b4bb9099e97039a7c548e409a97d6187d731c60d7b8696e193f35e705dd07fc41a7c2407e04d91d42beef3f81973d3f8f258afd8ab78acb5c1122720e031a
@@ -1,6 +1,6 @@
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
@@ -1,6 +1,6 @@
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
@@ -23,512 +23,572 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
23
 
24
24
  Aws::Plugins::GlobalConfiguration.add_identifier(:health)
25
25
 
26
- module Aws
27
- module Health
28
- class Client < Seahorse::Client::Base
26
+ module Aws::Health
27
+ class Client < Seahorse::Client::Base
29
28
 
30
- include Aws::ClientStubs
29
+ include Aws::ClientStubs
31
30
 
32
- @identifier = :health
31
+ @identifier = :health
33
32
 
34
- set_api(ClientApi::API)
33
+ set_api(ClientApi::API)
35
34
 
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::JsonRpc)
35
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
36
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
37
+ add_plugin(Aws::Plugins::Logging)
38
+ add_plugin(Aws::Plugins::ParamConverter)
39
+ add_plugin(Aws::Plugins::ParamValidator)
40
+ add_plugin(Aws::Plugins::UserAgent)
41
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
42
+ add_plugin(Aws::Plugins::RetryErrors)
43
+ add_plugin(Aws::Plugins::GlobalConfiguration)
44
+ add_plugin(Aws::Plugins::RegionalEndpoint)
45
+ add_plugin(Aws::Plugins::ResponsePaging)
46
+ add_plugin(Aws::Plugins::StubResponses)
47
+ add_plugin(Aws::Plugins::IdempotencyToken)
48
+ add_plugin(Aws::Plugins::SignatureV4)
49
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
50
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :simple_json (false)
117
- # Disables request parameter conversion, validation, and formatting.
118
- # Also disable response data type conversions. This option is useful
119
- # when you want to ensure the highest level of performance by
120
- # avoiding overhead of walking request parameters and response data
121
- # structures.
122
- #
123
- # When `:simple_json` is enabled, the request parameters hash must
124
- # be formatted exactly as the DynamoDB API expects.
125
- # @option options [Boolean] :stub_responses (false)
126
- # Causes the client to return stubbed responses. By default
127
- # fake responses are generated and returned. You can specify
128
- # the response data to return or errors to raise by calling
129
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
130
- #
131
- # ** Please note ** When response stubbing is enabled, no HTTP
132
- # requests are made, and retries are disabled.
133
- # @option options [Boolean] :validate_params (true)
134
- # When `true`, request parameters are validated before
135
- # sending the request.
136
- def initialize(*args)
137
- super
138
- end
139
-
140
- # @!group API Operations
51
+ # @option options [required, Aws::CredentialProvider] :credentials
52
+ # Your AWS credentials. This can be an instance of any one of the
53
+ # following classes:
54
+ #
55
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
56
+ # credentials.
57
+ #
58
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
59
+ # from an EC2 IMDS on an EC2 instance.
60
+ #
61
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
62
+ # shared file, such as `~/.aws/config`.
63
+ #
64
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
65
+ #
66
+ # When `:credentials` are not configured directly, the following
67
+ # locations will be searched for credentials:
68
+ #
69
+ # * `Aws.config[:credentials]`
70
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
71
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
72
+ # * `~/.aws/credentials`
73
+ # * `~/.aws/config`
74
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
75
+ # very aggressive. Construct and pass an instance of
76
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
77
+ # timeouts.
78
+ #
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ #
91
+ # @option options [String] :access_key_id
92
+ #
93
+ # @option options [Boolean] :convert_params (true)
94
+ # When `true`, an attempt is made to coerce request parameters into
95
+ # the required types.
96
+ #
97
+ # @option options [String] :endpoint
98
+ # The client endpoint is normally constructed from the `:region`
99
+ # option. You should only configure an `:endpoint` when connecting
100
+ # to test endpoints. This should be avalid HTTP(S) URI.
101
+ #
102
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
103
+ # The log formatter.
104
+ #
105
+ # @option options [Symbol] :log_level (:info)
106
+ # The log level to send messages to the `:logger` at.
107
+ #
108
+ # @option options [Logger] :logger
109
+ # The Logger instance to send log messages to. If this option
110
+ # is not set, logging will be disabled.
111
+ #
112
+ # @option options [String] :profile ("default")
113
+ # Used when loading credentials from the shared credentials file
114
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
115
+ #
116
+ # @option options [Integer] :retry_limit (3)
117
+ # The maximum number of times to retry failed requests. Only
118
+ # ~ 500 level server errors and certain ~ 400 level client errors
119
+ # are retried. Generally, these are throttling errors, data
120
+ # checksum errors, networking errors, timeout errors and auth
121
+ # errors from expired credentials.
122
+ #
123
+ # @option options [String] :secret_access_key
124
+ #
125
+ # @option options [String] :session_token
126
+ #
127
+ # @option options [Boolean] :simple_json (false)
128
+ # Disables request parameter conversion, validation, and formatting.
129
+ # Also disable response data type conversions. This option is useful
130
+ # when you want to ensure the highest level of performance by
131
+ # avoiding overhead of walking request parameters and response data
132
+ # structures.
133
+ #
134
+ # When `:simple_json` is enabled, the request parameters hash must
135
+ # be formatted exactly as the DynamoDB API expects.
136
+ #
137
+ # @option options [Boolean] :stub_responses (false)
138
+ # Causes the client to return stubbed responses. By default
139
+ # fake responses are generated and returned. You can specify
140
+ # the response data to return or errors to raise by calling
141
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
142
+ #
143
+ # ** Please note ** When response stubbing is enabled, no HTTP
144
+ # requests are made, and retries are disabled.
145
+ #
146
+ # @option options [Boolean] :validate_params (true)
147
+ # When `true`, request parameters are validated before
148
+ # sending the request.
149
+ #
150
+ def initialize(*args)
151
+ super
152
+ end
141
153
 
142
- # Returns a list of entities that have been affected by the specified
143
- # events, based on the specified filter criteria. Entities can refer to
144
- # individual customer resources, groups of customer resources, or any
145
- # other construct, depending on the AWS service. Events that have impact
146
- # beyond that of the affected entities, or where the extent of impact is
147
- # unknown, include at least one entity indicating this.
148
- #
149
- # At least one event ARN is required. Results are sorted by the
150
- # `lastUpdatedTime` of the entity, starting with the most recent.
151
- # @option params [required, Types::EntityFilter] :filter
152
- # Values to narrow the results returned. At least one event ARN is
153
- # required.
154
- # @option params [String] :locale
155
- # The locale (language) to return information in. The default is
156
- # English.
157
- # @option params [String] :next_token
158
- # If the results of a search are large, only a portion of the results
159
- # are returned, and a `nextToken` pagination token is returned in the
160
- # response. To retrieve the next batch of results, reissue the search
161
- # request and include the returned token. When all results have been
162
- # returned, the response does not contain a pagination token value.
163
- # @option params [Integer] :max_results
164
- # The maximum number of items to return in one batch.
165
- # @return [Types::DescribeAffectedEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
166
- #
167
- # * {Types::DescribeAffectedEntitiesResponse#entities #entities} => Array&lt;Types::AffectedEntity&gt;
168
- # * {Types::DescribeAffectedEntitiesResponse#next_token #nextToken} => String
169
- #
170
- # @example Request syntax with placeholder values
171
- # resp = client.describe_affected_entities({
172
- # filter: { # required
173
- # event_arns: ["eventArn"], # required
174
- # entity_arns: ["entityArn"],
175
- # entity_values: ["entityValue"],
176
- # last_updated_times: [
177
- # {
178
- # from: Time.now,
179
- # to: Time.now,
180
- # },
181
- # ],
182
- # tags: [
183
- # {
184
- # "tagKey" => "tagValue",
185
- # },
186
- # ],
187
- # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
188
- # },
189
- # locale: "locale",
190
- # next_token: "nextToken",
191
- # max_results: 1,
192
- # })
193
- #
194
- # @example Response structure
195
- # resp.entities #=> Array
196
- # resp.entities[0].entity_arn #=> String
197
- # resp.entities[0].event_arn #=> String
198
- # resp.entities[0].entity_value #=> String
199
- # resp.entities[0].aws_account_id #=> String
200
- # resp.entities[0].last_updated_time #=> Time
201
- # resp.entities[0].status_code #=> String, one of "IMPAIRED", "UNIMPAIRED", "UNKNOWN"
202
- # resp.entities[0].tags #=> Hash
203
- # resp.entities[0].tags["tagKey"] #=> String
204
- # resp.next_token #=> String
205
- # @overload describe_affected_entities(params = {})
206
- # @param [Hash] params ({})
207
- def describe_affected_entities(params = {}, options = {})
208
- req = build_request(:describe_affected_entities, params)
209
- req.send_request(options)
210
- end
154
+ # @!group API Operations
211
155
 
212
- # Returns the number of entities that are affected by each of the
213
- # specified events. If no events are specified, the counts of all
214
- # affected entities are returned.
215
- # @option params [Array<String>] :event_arns
216
- # A list of event ARNs (unique identifiers). For example:
217
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
218
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
219
- # @return [Types::DescribeEntityAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
220
- #
221
- # * {Types::DescribeEntityAggregatesResponse#entity_aggregates #entityAggregates} => Array&lt;Types::EntityAggregate&gt;
222
- #
223
- # @example Request syntax with placeholder values
224
- # resp = client.describe_entity_aggregates({
225
- # event_arns: ["eventArn"],
226
- # })
227
- #
228
- # @example Response structure
229
- # resp.entity_aggregates #=> Array
230
- # resp.entity_aggregates[0].event_arn #=> String
231
- # resp.entity_aggregates[0].count #=> Integer
232
- # @overload describe_entity_aggregates(params = {})
233
- # @param [Hash] params ({})
234
- def describe_entity_aggregates(params = {}, options = {})
235
- req = build_request(:describe_entity_aggregates, params)
236
- req.send_request(options)
237
- end
156
+ # Returns a list of entities that have been affected by the specified
157
+ # events, based on the specified filter criteria. Entities can refer to
158
+ # individual customer resources, groups of customer resources, or any
159
+ # other construct, depending on the AWS service. Events that have impact
160
+ # beyond that of the affected entities, or where the extent of impact is
161
+ # unknown, include at least one entity indicating this.
162
+ #
163
+ # At least one event ARN is required. Results are sorted by the
164
+ # `lastUpdatedTime` of the entity, starting with the most recent.
165
+ #
166
+ # @option params [required, Types::EntityFilter] :filter
167
+ # Values to narrow the results returned. At least one event ARN is
168
+ # required.
169
+ #
170
+ # @option params [String] :locale
171
+ # The locale (language) to return information in. English (en) is the
172
+ # default and the only supported value at this time.
173
+ #
174
+ # @option params [String] :next_token
175
+ # If the results of a search are large, only a portion of the results
176
+ # are returned, and a `nextToken` pagination token is returned in the
177
+ # response. To retrieve the next batch of results, reissue the search
178
+ # request and include the returned token. When all results have been
179
+ # returned, the response does not contain a pagination token value.
180
+ #
181
+ # @option params [Integer] :max_results
182
+ # The maximum number of items to return in one batch, between 10 and
183
+ # 100, inclusive.
184
+ #
185
+ # @return [Types::DescribeAffectedEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
186
+ #
187
+ # * {Types::DescribeAffectedEntitiesResponse#entities #entities} => Array&lt;Types::AffectedEntity&gt;
188
+ # * {Types::DescribeAffectedEntitiesResponse#next_token #next_token} => String
189
+ #
190
+ # @example Request syntax with placeholder values
191
+ #
192
+ # resp = client.describe_affected_entities({
193
+ # filter: { # required
194
+ # event_arns: ["eventArn"], # required
195
+ # entity_arns: ["entityArn"],
196
+ # entity_values: ["entityValue"],
197
+ # last_updated_times: [
198
+ # {
199
+ # from: Time.now,
200
+ # to: Time.now,
201
+ # },
202
+ # ],
203
+ # tags: [
204
+ # {
205
+ # "tagKey" => "tagValue",
206
+ # },
207
+ # ],
208
+ # status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
209
+ # },
210
+ # locale: "locale",
211
+ # next_token: "nextToken",
212
+ # max_results: 1,
213
+ # })
214
+ #
215
+ # @example Response structure
216
+ #
217
+ # resp.entities #=> Array
218
+ # resp.entities[0].entity_arn #=> String
219
+ # resp.entities[0].event_arn #=> String
220
+ # resp.entities[0].entity_value #=> String
221
+ # resp.entities[0].aws_account_id #=> String
222
+ # resp.entities[0].last_updated_time #=> Time
223
+ # resp.entities[0].status_code #=> String, one of "IMPAIRED", "UNIMPAIRED", "UNKNOWN"
224
+ # resp.entities[0].tags #=> Hash
225
+ # resp.entities[0].tags["tagKey"] #=> String
226
+ # resp.next_token #=> String
227
+ #
228
+ # @overload describe_affected_entities(params = {})
229
+ # @param [Hash] params ({})
230
+ def describe_affected_entities(params = {}, options = {})
231
+ req = build_request(:describe_affected_entities, params)
232
+ req.send_request(options)
233
+ end
238
234
 
239
- # Returns the number of events of each event type (issue, scheduled
240
- # change, and account notification). If no filter is specified, the
241
- # counts of all events in each category are returned.
242
- # @option params [Types::EventFilter] :filter
243
- # Values to narrow the results returned.
244
- # @option params [required, String] :aggregate_field
245
- # The only currently supported value is `eventTypeCategory`.
246
- # @option params [Integer] :max_results
247
- # The maximum number of items to return in one batch.
248
- # @option params [String] :next_token
249
- # If the results of a search are large, only a portion of the results
250
- # are returned, and a `nextToken` pagination token is returned in the
251
- # response. To retrieve the next batch of results, reissue the search
252
- # request and include the returned token. When all results have been
253
- # returned, the response does not contain a pagination token value.
254
- # @return [Types::DescribeEventAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
255
- #
256
- # * {Types::DescribeEventAggregatesResponse#event_aggregates #eventAggregates} => Array&lt;Types::EventAggregate&gt;
257
- # * {Types::DescribeEventAggregatesResponse#next_token #nextToken} => String
258
- #
259
- # @example Request syntax with placeholder values
260
- # resp = client.describe_event_aggregates({
261
- # filter: {
262
- # event_arns: ["eventArn"],
263
- # event_type_codes: ["eventType"],
264
- # services: ["service"],
265
- # regions: ["region"],
266
- # availability_zones: ["availabilityZone"],
267
- # start_times: [
268
- # {
269
- # from: Time.now,
270
- # to: Time.now,
271
- # },
272
- # ],
273
- # end_times: [
274
- # {
275
- # from: Time.now,
276
- # to: Time.now,
277
- # },
278
- # ],
279
- # last_updated_times: [
280
- # {
281
- # from: Time.now,
282
- # to: Time.now,
283
- # },
284
- # ],
285
- # entity_arns: ["entityArn"],
286
- # entity_values: ["entityValue"],
287
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
288
- # tags: [
289
- # {
290
- # "tagKey" => "tagValue",
291
- # },
292
- # ],
293
- # event_status_codes: ["open"], # accepts open, closed, upcoming
294
- # },
295
- # aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
296
- # max_results: 1,
297
- # next_token: "nextToken",
298
- # })
299
- #
300
- # @example Response structure
301
- # resp.event_aggregates #=> Array
302
- # resp.event_aggregates[0].aggregate_value #=> String
303
- # resp.event_aggregates[0].count #=> Integer
304
- # resp.next_token #=> String
305
- # @overload describe_event_aggregates(params = {})
306
- # @param [Hash] params ({})
307
- def describe_event_aggregates(params = {}, options = {})
308
- req = build_request(:describe_event_aggregates, params)
309
- req.send_request(options)
310
- end
235
+ # Returns the number of entities that are affected by each of the
236
+ # specified events. If no events are specified, the counts of all
237
+ # affected entities are returned.
238
+ #
239
+ # @option params [Array<String>] :event_arns
240
+ # A list of event ARNs (unique identifiers). For example:
241
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
242
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
243
+ #
244
+ # @return [Types::DescribeEntityAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
245
+ #
246
+ # * {Types::DescribeEntityAggregatesResponse#entity_aggregates #entity_aggregates} => Array&lt;Types::EntityAggregate&gt;
247
+ #
248
+ # @example Request syntax with placeholder values
249
+ #
250
+ # resp = client.describe_entity_aggregates({
251
+ # event_arns: ["eventArn"],
252
+ # })
253
+ #
254
+ # @example Response structure
255
+ #
256
+ # resp.entity_aggregates #=> Array
257
+ # resp.entity_aggregates[0].event_arn #=> String
258
+ # resp.entity_aggregates[0].count #=> Integer
259
+ #
260
+ # @overload describe_entity_aggregates(params = {})
261
+ # @param [Hash] params ({})
262
+ def describe_entity_aggregates(params = {}, options = {})
263
+ req = build_request(:describe_entity_aggregates, params)
264
+ req.send_request(options)
265
+ end
311
266
 
312
- # Returns detailed information about one or more specified events.
313
- # Information includes standard event data (region, service, etc., as
314
- # returned by DescribeEvents), a detailed event description, and
315
- # possible additional metadata that depends upon the nature of the
316
- # event. Affected entities are not included; to retrieve those, use the
317
- # DescribeAffectedEntities operation.
318
- #
319
- # If a specified event cannot be retrieved, an error message is returned
320
- # for that event.
321
- # @option params [required, Array<String>] :event_arns
322
- # A list of event ARNs (unique identifiers). For example:
323
- # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
324
- # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
325
- # @option params [String] :locale
326
- # The locale (language) to return information in. The default is
327
- # English.
328
- # @return [Types::DescribeEventDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
329
- #
330
- # * {Types::DescribeEventDetailsResponse#successful_set #successfulSet} => Array&lt;Types::EventDetails&gt;
331
- # * {Types::DescribeEventDetailsResponse#failed_set #failedSet} => Array&lt;Types::EventDetailsErrorItem&gt;
332
- #
333
- # @example Request syntax with placeholder values
334
- # resp = client.describe_event_details({
335
- # event_arns: ["eventArn"], # required
336
- # locale: "locale",
337
- # })
338
- #
339
- # @example Response structure
340
- # resp.successful_set #=> Array
341
- # resp.successful_set[0].event.arn #=> String
342
- # resp.successful_set[0].event.service #=> String
343
- # resp.successful_set[0].event.event_type_code #=> String
344
- # resp.successful_set[0].event.event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange"
345
- # resp.successful_set[0].event.region #=> String
346
- # resp.successful_set[0].event.availability_zone #=> String
347
- # resp.successful_set[0].event.start_time #=> Time
348
- # resp.successful_set[0].event.end_time #=> Time
349
- # resp.successful_set[0].event.last_updated_time #=> Time
350
- # resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
351
- # resp.successful_set[0].event_description.latest_description #=> String
352
- # resp.successful_set[0].event_metadata #=> Hash
353
- # resp.successful_set[0].event_metadata["metadataKey"] #=> String
354
- # resp.failed_set #=> Array
355
- # resp.failed_set[0].event_arn #=> String
356
- # resp.failed_set[0].error_name #=> String
357
- # resp.failed_set[0].error_message #=> String
358
- # @overload describe_event_details(params = {})
359
- # @param [Hash] params ({})
360
- def describe_event_details(params = {}, options = {})
361
- req = build_request(:describe_event_details, params)
362
- req.send_request(options)
363
- end
267
+ # Returns the number of events of each event type (issue, scheduled
268
+ # change, and account notification). If no filter is specified, the
269
+ # counts of all events in each category are returned.
270
+ #
271
+ # @option params [Types::EventFilter] :filter
272
+ # Values to narrow the results returned.
273
+ #
274
+ # @option params [required, String] :aggregate_field
275
+ # The only currently supported value is `eventTypeCategory`.
276
+ #
277
+ # @option params [Integer] :max_results
278
+ # The maximum number of items to return in one batch, between 10 and
279
+ # 100, inclusive.
280
+ #
281
+ # @option params [String] :next_token
282
+ # If the results of a search are large, only a portion of the results
283
+ # are returned, and a `nextToken` pagination token is returned in the
284
+ # response. To retrieve the next batch of results, reissue the search
285
+ # request and include the returned token. When all results have been
286
+ # returned, the response does not contain a pagination token value.
287
+ #
288
+ # @return [Types::DescribeEventAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
289
+ #
290
+ # * {Types::DescribeEventAggregatesResponse#event_aggregates #event_aggregates} => Array&lt;Types::EventAggregate&gt;
291
+ # * {Types::DescribeEventAggregatesResponse#next_token #next_token} => String
292
+ #
293
+ # @example Request syntax with placeholder values
294
+ #
295
+ # resp = client.describe_event_aggregates({
296
+ # filter: {
297
+ # event_arns: ["eventArn"],
298
+ # event_type_codes: ["eventType"],
299
+ # services: ["service"],
300
+ # regions: ["region"],
301
+ # availability_zones: ["availabilityZone"],
302
+ # start_times: [
303
+ # {
304
+ # from: Time.now,
305
+ # to: Time.now,
306
+ # },
307
+ # ],
308
+ # end_times: [
309
+ # {
310
+ # from: Time.now,
311
+ # to: Time.now,
312
+ # },
313
+ # ],
314
+ # last_updated_times: [
315
+ # {
316
+ # from: Time.now,
317
+ # to: Time.now,
318
+ # },
319
+ # ],
320
+ # entity_arns: ["entityArn"],
321
+ # entity_values: ["entityValue"],
322
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
323
+ # tags: [
324
+ # {
325
+ # "tagKey" => "tagValue",
326
+ # },
327
+ # ],
328
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
329
+ # },
330
+ # aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
331
+ # max_results: 1,
332
+ # next_token: "nextToken",
333
+ # })
334
+ #
335
+ # @example Response structure
336
+ #
337
+ # resp.event_aggregates #=> Array
338
+ # resp.event_aggregates[0].aggregate_value #=> String
339
+ # resp.event_aggregates[0].count #=> Integer
340
+ # resp.next_token #=> String
341
+ #
342
+ # @overload describe_event_aggregates(params = {})
343
+ # @param [Hash] params ({})
344
+ def describe_event_aggregates(params = {}, options = {})
345
+ req = build_request(:describe_event_aggregates, params)
346
+ req.send_request(options)
347
+ end
364
348
 
365
- # Returns the event types that meet the specified filter criteria. If no
366
- # filter criteria are specified, all event types are returned, in no
367
- # particular order.
368
- # @option params [Types::EventTypeFilter] :filter
369
- # Values to narrow the results returned.
370
- # @option params [String] :locale
371
- # The locale (language) to return information in. The default is
372
- # English.
373
- # @option params [String] :next_token
374
- # If the results of a search are large, only a portion of the results
375
- # are returned, and a `nextToken` pagination token is returned in the
376
- # response. To retrieve the next batch of results, reissue the search
377
- # request and include the returned token. When all results have been
378
- # returned, the response does not contain a pagination token value.
379
- # @option params [Integer] :max_results
380
- # The maximum number of items to return in one batch.
381
- # @return [Types::DescribeEventTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
382
- #
383
- # * {Types::DescribeEventTypesResponse#event_types #eventTypes} => Array&lt;Types::EventType&gt;
384
- # * {Types::DescribeEventTypesResponse#next_token #nextToken} => String
385
- #
386
- # @example Request syntax with placeholder values
387
- # resp = client.describe_event_types({
388
- # filter: {
389
- # event_type_codes: ["eventTypeCode"],
390
- # services: ["service"],
391
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
392
- # },
393
- # locale: "locale",
394
- # next_token: "nextToken",
395
- # max_results: 1,
396
- # })
397
- #
398
- # @example Response structure
399
- # resp.event_types #=> Array
400
- # resp.event_types[0].service #=> String
401
- # resp.event_types[0].code #=> String
402
- # resp.event_types[0].category #=> String, one of "issue", "accountNotification", "scheduledChange"
403
- # resp.next_token #=> String
404
- # @overload describe_event_types(params = {})
405
- # @param [Hash] params ({})
406
- def describe_event_types(params = {}, options = {})
407
- req = build_request(:describe_event_types, params)
408
- req.send_request(options)
409
- end
349
+ # Returns detailed information about one or more specified events.
350
+ # Information includes standard event data (region, service, etc., as
351
+ # returned by DescribeEvents), a detailed event description, and
352
+ # possible additional metadata that depends upon the nature of the
353
+ # event. Affected entities are not included; to retrieve those, use the
354
+ # DescribeAffectedEntities operation.
355
+ #
356
+ # If a specified event cannot be retrieved, an error message is returned
357
+ # for that event.
358
+ #
359
+ # @option params [required, Array<String>] :event_arns
360
+ # A list of event ARNs (unique identifiers). For example:
361
+ # `"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
362
+ # "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"`
363
+ #
364
+ # @option params [String] :locale
365
+ # The locale (language) to return information in. English (en) is the
366
+ # default and the only supported value at this time.
367
+ #
368
+ # @return [Types::DescribeEventDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
369
+ #
370
+ # * {Types::DescribeEventDetailsResponse#successful_set #successful_set} => Array&lt;Types::EventDetails&gt;
371
+ # * {Types::DescribeEventDetailsResponse#failed_set #failed_set} => Array&lt;Types::EventDetailsErrorItem&gt;
372
+ #
373
+ # @example Request syntax with placeholder values
374
+ #
375
+ # resp = client.describe_event_details({
376
+ # event_arns: ["eventArn"], # required
377
+ # locale: "locale",
378
+ # })
379
+ #
380
+ # @example Response structure
381
+ #
382
+ # resp.successful_set #=> Array
383
+ # resp.successful_set[0].event.arn #=> String
384
+ # resp.successful_set[0].event.service #=> String
385
+ # resp.successful_set[0].event.event_type_code #=> String
386
+ # resp.successful_set[0].event.event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange"
387
+ # resp.successful_set[0].event.region #=> String
388
+ # resp.successful_set[0].event.availability_zone #=> String
389
+ # resp.successful_set[0].event.start_time #=> Time
390
+ # resp.successful_set[0].event.end_time #=> Time
391
+ # resp.successful_set[0].event.last_updated_time #=> Time
392
+ # resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
393
+ # resp.successful_set[0].event_description.latest_description #=> String
394
+ # resp.successful_set[0].event_metadata #=> Hash
395
+ # resp.successful_set[0].event_metadata["metadataKey"] #=> String
396
+ # resp.failed_set #=> Array
397
+ # resp.failed_set[0].event_arn #=> String
398
+ # resp.failed_set[0].error_name #=> String
399
+ # resp.failed_set[0].error_message #=> String
400
+ #
401
+ # @overload describe_event_details(params = {})
402
+ # @param [Hash] params ({})
403
+ def describe_event_details(params = {}, options = {})
404
+ req = build_request(:describe_event_details, params)
405
+ req.send_request(options)
406
+ end
410
407
 
411
- # Returns information about events that meet the specified filter
412
- # criteria. Events are returned in a summary form and do not include the
413
- # detailed description, any additional metadata that depends on the
414
- # event type, or any affected resources. To retrieve that information,
415
- # use the DescribeEventDetails and DescribeAffectedEntities operations.
416
- #
417
- # If no filter criteria are specified, all events are returned. Results
418
- # are sorted by `lastModifiedTime`, starting with the most recent.
419
- # @option params [Types::EventFilter] :filter
420
- # Values to narrow the results returned.
421
- # @option params [String] :next_token
422
- # If the results of a search are large, only a portion of the results
423
- # are returned, and a `nextToken` pagination token is returned in the
424
- # response. To retrieve the next batch of results, reissue the search
425
- # request and include the returned token. When all results have been
426
- # returned, the response does not contain a pagination token value.
427
- # @option params [Integer] :max_results
428
- # The maximum number of items to return in one batch.
429
- # @option params [String] :locale
430
- # The locale (language) to return information in. The default is
431
- # English.
432
- # @return [Types::DescribeEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
433
- #
434
- # * {Types::DescribeEventsResponse#events #events} => Array&lt;Types::Event&gt;
435
- # * {Types::DescribeEventsResponse#next_token #nextToken} => String
436
- #
437
- # @example Request syntax with placeholder values
438
- # resp = client.describe_events({
439
- # filter: {
440
- # event_arns: ["eventArn"],
441
- # event_type_codes: ["eventType"],
442
- # services: ["service"],
443
- # regions: ["region"],
444
- # availability_zones: ["availabilityZone"],
445
- # start_times: [
446
- # {
447
- # from: Time.now,
448
- # to: Time.now,
449
- # },
450
- # ],
451
- # end_times: [
452
- # {
453
- # from: Time.now,
454
- # to: Time.now,
455
- # },
456
- # ],
457
- # last_updated_times: [
458
- # {
459
- # from: Time.now,
460
- # to: Time.now,
461
- # },
462
- # ],
463
- # entity_arns: ["entityArn"],
464
- # entity_values: ["entityValue"],
465
- # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
466
- # tags: [
467
- # {
468
- # "tagKey" => "tagValue",
469
- # },
470
- # ],
471
- # event_status_codes: ["open"], # accepts open, closed, upcoming
472
- # },
473
- # next_token: "nextToken",
474
- # max_results: 1,
475
- # locale: "locale",
476
- # })
477
- #
478
- # @example Response structure
479
- # resp.events #=> Array
480
- # resp.events[0].arn #=> String
481
- # resp.events[0].service #=> String
482
- # resp.events[0].event_type_code #=> String
483
- # resp.events[0].event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange"
484
- # resp.events[0].region #=> String
485
- # resp.events[0].availability_zone #=> String
486
- # resp.events[0].start_time #=> Time
487
- # resp.events[0].end_time #=> Time
488
- # resp.events[0].last_updated_time #=> Time
489
- # resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
490
- # resp.next_token #=> String
491
- # @overload describe_events(params = {})
492
- # @param [Hash] params ({})
493
- def describe_events(params = {}, options = {})
494
- req = build_request(:describe_events, params)
495
- req.send_request(options)
496
- end
408
+ # Returns the event types that meet the specified filter criteria. If no
409
+ # filter criteria are specified, all event types are returned, in no
410
+ # particular order.
411
+ #
412
+ # @option params [Types::EventTypeFilter] :filter
413
+ # Values to narrow the results returned.
414
+ #
415
+ # @option params [String] :locale
416
+ # The locale (language) to return information in. English (en) is the
417
+ # default and the only supported value at this time.
418
+ #
419
+ # @option params [String] :next_token
420
+ # If the results of a search are large, only a portion of the results
421
+ # are returned, and a `nextToken` pagination token is returned in the
422
+ # response. To retrieve the next batch of results, reissue the search
423
+ # request and include the returned token. When all results have been
424
+ # returned, the response does not contain a pagination token value.
425
+ #
426
+ # @option params [Integer] :max_results
427
+ # The maximum number of items to return in one batch, between 10 and
428
+ # 100, inclusive.
429
+ #
430
+ # @return [Types::DescribeEventTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
431
+ #
432
+ # * {Types::DescribeEventTypesResponse#event_types #event_types} => Array&lt;Types::EventType&gt;
433
+ # * {Types::DescribeEventTypesResponse#next_token #next_token} => String
434
+ #
435
+ # @example Request syntax with placeholder values
436
+ #
437
+ # resp = client.describe_event_types({
438
+ # filter: {
439
+ # event_type_codes: ["eventTypeCode"],
440
+ # services: ["service"],
441
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
442
+ # },
443
+ # locale: "locale",
444
+ # next_token: "nextToken",
445
+ # max_results: 1,
446
+ # })
447
+ #
448
+ # @example Response structure
449
+ #
450
+ # resp.event_types #=> Array
451
+ # resp.event_types[0].service #=> String
452
+ # resp.event_types[0].code #=> String
453
+ # resp.event_types[0].category #=> String, one of "issue", "accountNotification", "scheduledChange"
454
+ # resp.next_token #=> String
455
+ #
456
+ # @overload describe_event_types(params = {})
457
+ # @param [Hash] params ({})
458
+ def describe_event_types(params = {}, options = {})
459
+ req = build_request(:describe_event_types, params)
460
+ req.send_request(options)
461
+ end
497
462
 
498
- # @!endgroup
463
+ # Returns information about events that meet the specified filter
464
+ # criteria. Events are returned in a summary form and do not include the
465
+ # detailed description, any additional metadata that depends on the
466
+ # event type, or any affected resources. To retrieve that information,
467
+ # use the DescribeEventDetails and DescribeAffectedEntities operations.
468
+ #
469
+ # If no filter criteria are specified, all events are returned. Results
470
+ # are sorted by `lastModifiedTime`, starting with the most recent.
471
+ #
472
+ # @option params [Types::EventFilter] :filter
473
+ # Values to narrow the results returned.
474
+ #
475
+ # @option params [String] :next_token
476
+ # If the results of a search are large, only a portion of the results
477
+ # are returned, and a `nextToken` pagination token is returned in the
478
+ # response. To retrieve the next batch of results, reissue the search
479
+ # request and include the returned token. When all results have been
480
+ # returned, the response does not contain a pagination token value.
481
+ #
482
+ # @option params [Integer] :max_results
483
+ # The maximum number of items to return in one batch, between 10 and
484
+ # 100, inclusive.
485
+ #
486
+ # @option params [String] :locale
487
+ # The locale (language) to return information in. English (en) is the
488
+ # default and the only supported value at this time.
489
+ #
490
+ # @return [Types::DescribeEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
491
+ #
492
+ # * {Types::DescribeEventsResponse#events #events} => Array&lt;Types::Event&gt;
493
+ # * {Types::DescribeEventsResponse#next_token #next_token} => String
494
+ #
495
+ # @example Request syntax with placeholder values
496
+ #
497
+ # resp = client.describe_events({
498
+ # filter: {
499
+ # event_arns: ["eventArn"],
500
+ # event_type_codes: ["eventType"],
501
+ # services: ["service"],
502
+ # regions: ["region"],
503
+ # availability_zones: ["availabilityZone"],
504
+ # start_times: [
505
+ # {
506
+ # from: Time.now,
507
+ # to: Time.now,
508
+ # },
509
+ # ],
510
+ # end_times: [
511
+ # {
512
+ # from: Time.now,
513
+ # to: Time.now,
514
+ # },
515
+ # ],
516
+ # last_updated_times: [
517
+ # {
518
+ # from: Time.now,
519
+ # to: Time.now,
520
+ # },
521
+ # ],
522
+ # entity_arns: ["entityArn"],
523
+ # entity_values: ["entityValue"],
524
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
525
+ # tags: [
526
+ # {
527
+ # "tagKey" => "tagValue",
528
+ # },
529
+ # ],
530
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
531
+ # },
532
+ # next_token: "nextToken",
533
+ # max_results: 1,
534
+ # locale: "locale",
535
+ # })
536
+ #
537
+ # @example Response structure
538
+ #
539
+ # resp.events #=> Array
540
+ # resp.events[0].arn #=> String
541
+ # resp.events[0].service #=> String
542
+ # resp.events[0].event_type_code #=> String
543
+ # resp.events[0].event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange"
544
+ # resp.events[0].region #=> String
545
+ # resp.events[0].availability_zone #=> String
546
+ # resp.events[0].start_time #=> Time
547
+ # resp.events[0].end_time #=> Time
548
+ # resp.events[0].last_updated_time #=> Time
549
+ # resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
550
+ # resp.next_token #=> String
551
+ #
552
+ # @overload describe_events(params = {})
553
+ # @param [Hash] params ({})
554
+ def describe_events(params = {}, options = {})
555
+ req = build_request(:describe_events, params)
556
+ req.send_request(options)
557
+ end
499
558
 
500
- # @param params ({})
501
- # @api private
502
- def build_request(operation_name, params = {})
503
- handlers = @handlers.for(operation_name)
504
- context = Seahorse::Client::RequestContext.new(
505
- operation_name: operation_name,
506
- operation: config.api.operation(operation_name),
507
- client: self,
508
- params: params,
509
- config: config)
510
- context[:gem_name] = 'aws-sdk-health'
511
- context[:gem_version] = '1.0.0.rc2'
512
- Seahorse::Client::Request.new(handlers, context)
513
- end
559
+ # @!endgroup
514
560
 
515
- # @api private
516
- # @deprecated
517
- def waiter_names
518
- []
519
- end
561
+ # @param params ({})
562
+ # @api private
563
+ def build_request(operation_name, params = {})
564
+ handlers = @handlers.for(operation_name)
565
+ context = Seahorse::Client::RequestContext.new(
566
+ operation_name: operation_name,
567
+ operation: config.api.operation(operation_name),
568
+ client: self,
569
+ params: params,
570
+ config: config)
571
+ context[:gem_name] = 'aws-sdk-health'
572
+ context[:gem_version] = '1.0.0.rc2'
573
+ Seahorse::Client::Request.new(handlers, context)
574
+ end
520
575
 
521
- class << self
576
+ # @api private
577
+ # @deprecated
578
+ def waiter_names
579
+ []
580
+ end
522
581
 
523
- # @api private
524
- attr_reader :identifier
582
+ class << self
525
583
 
526
- # @api private
527
- def errors_module
528
- Errors
529
- end
584
+ # @api private
585
+ attr_reader :identifier
530
586
 
587
+ # @api private
588
+ def errors_module
589
+ Errors
531
590
  end
591
+
532
592
  end
533
593
  end
534
594
  end