aws-sdk-health 1.20.0 → 1.25.0

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
- SHA1:
3
- metadata.gz: 040eef9ba937590643d7290afee70fc7a003260f
4
- data.tar.gz: cb3c12338f735782a2cc6fb38e6bfbdd12ef7b93
2
+ SHA256:
3
+ metadata.gz: 2d30285f86e1bea46925cfef6e3076e165f5712eb178118d2402c0af22218ca4
4
+ data.tar.gz: 3ee8f8a457ad613125c0c78249a26f25082fd907365f12da126bda547277cc8e
5
5
  SHA512:
6
- metadata.gz: d970c4c5f5058d59f04554bedd915cb0ca084468388e3819072e2c2b5f4457f7623d56674b9764d81ee774130a7b1b1454e29ac0a38c0fb5e47931006109b399
7
- data.tar.gz: 48b1b3de833c3e76d6ca19841572b98b5bd48330d4eb95b74ca8c4f87715dd807cef4dd0045b88501974c229ef5c616f3b8a2c6c03ae191657dc11ee6f411c83
6
+ metadata.gz: 7c902902a6bddc428af1913e65e0d810bbd46ce7a8dd667fd8af89aa2b464bd1910f55f5be73ad594aacf18fc141a416280c9603b03b4784db8531d5f47a238a
7
+ data.tar.gz: 045ebc8dcb715c1df827c3cbda36fd4f76e4469253ec014fe5fcd648b23e264100180555f75a6d797941d24709942c77ae983bb2f435da14191ab5fba817ea82
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-health/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # health = Aws::Health::Client.new
28
+ # resp = health.describe_affected_accounts_for_organization(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Health APIs and Notifications all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Health APIs and Notifications are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Health::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Health APIs and Notifications API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-health/customizations'
42
45
  # @service
43
46
  module Aws::Health
44
47
 
45
- GEM_VERSION = '1.20.0'
48
+ GEM_VERSION = '1.25.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:health)
31
31
 
32
32
  module Aws::Health
33
+ # An API client for Health. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Health::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::Health
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::Health
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::Health
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::Health
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::Health
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::Health
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::Health
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::Health
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::Health
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -264,6 +318,63 @@ module Aws::Health
264
318
 
265
319
  # @!group API Operations
266
320
 
321
+ # Returns a list of accounts in the organization from AWS Organizations
322
+ # that are affected by the provided event.
323
+ #
324
+ # Before you can call this operation, you must first enable AWS Health
325
+ # to work with AWS Organizations. To do this, call the
326
+ # EnableHealthServiceAccessForOrganization operation from your
327
+ # organization's master account.
328
+ #
329
+ # @option params [required, String] :event_arn
330
+ # The unique identifier for the event. Format:
331
+ # `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
332
+ # `. Example: `Example:
333
+ # arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
334
+ #
335
+ # @option params [String] :next_token
336
+ # If the results of a search are large, only a portion of the results
337
+ # are returned, and a `nextToken` pagination token is returned in the
338
+ # response. To retrieve the next batch of results, reissue the search
339
+ # request and include the returned token. When all results have been
340
+ # returned, the response does not contain a pagination token value.
341
+ #
342
+ # @option params [Integer] :max_results
343
+ # The maximum number of items to return in one batch, between 10 and
344
+ # 100, inclusive.
345
+ #
346
+ # @return [Types::DescribeAffectedAccountsForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
347
+ #
348
+ # * {Types::DescribeAffectedAccountsForOrganizationResponse#affected_accounts #affected_accounts} => Array&lt;String&gt;
349
+ # * {Types::DescribeAffectedAccountsForOrganizationResponse#event_scope_code #event_scope_code} => String
350
+ # * {Types::DescribeAffectedAccountsForOrganizationResponse#next_token #next_token} => String
351
+ #
352
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
353
+ #
354
+ # @example Request syntax with placeholder values
355
+ #
356
+ # resp = client.describe_affected_accounts_for_organization({
357
+ # event_arn: "eventArn", # required
358
+ # next_token: "nextToken",
359
+ # max_results: 1,
360
+ # })
361
+ #
362
+ # @example Response structure
363
+ #
364
+ # resp.affected_accounts #=> Array
365
+ # resp.affected_accounts[0] #=> String
366
+ # resp.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
367
+ # resp.next_token #=> String
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganization AWS API Documentation
370
+ #
371
+ # @overload describe_affected_accounts_for_organization(params = {})
372
+ # @param [Hash] params ({})
373
+ def describe_affected_accounts_for_organization(params = {}, options = {})
374
+ req = build_request(:describe_affected_accounts_for_organization, params)
375
+ req.send_request(options)
376
+ end
377
+
267
378
  # Returns a list of entities that have been affected by the specified
268
379
  # events, based on the specified filter criteria. Entities can refer to
269
380
  # individual customer resources, groups of customer resources, or any
@@ -298,6 +409,8 @@ module Aws::Health
298
409
  # * {Types::DescribeAffectedEntitiesResponse#entities #entities} => Array&lt;Types::AffectedEntity&gt;
299
410
  # * {Types::DescribeAffectedEntitiesResponse#next_token #next_token} => String
300
411
  #
412
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
413
+ #
301
414
  # @example Request syntax with placeholder values
302
415
  #
303
416
  # resp = client.describe_affected_entities({
@@ -346,6 +459,89 @@ module Aws::Health
346
459
  req.send_request(options)
347
460
  end
348
461
 
462
+ # Returns a list of entities that have been affected by one or more
463
+ # events for one or more accounts in your organization in AWS
464
+ # Organizations, based on the filter criteria. Entities can refer to
465
+ # individual customer resources, groups of customer resources, or any
466
+ # other construct, depending on the AWS service.
467
+ #
468
+ # At least one event ARN and account ID are required. Results are sorted
469
+ # by the `lastUpdatedTime` of the entity, starting with the most recent.
470
+ #
471
+ # Before you can call this operation, you must first enable AWS Health
472
+ # to work with AWS Organizations. To do this, call the
473
+ # EnableHealthServiceAccessForOrganization operation from your
474
+ # organization's master account.
475
+ #
476
+ # @option params [required, Array<Types::EventAccountFilter>] :organization_entity_filters
477
+ # A JSON set of elements including the `awsAccountId` and the
478
+ # `eventArn`.
479
+ #
480
+ # @option params [String] :locale
481
+ # The locale (language) to return information in. English (en) is the
482
+ # default and the only supported value at this time.
483
+ #
484
+ # @option params [String] :next_token
485
+ # If the results of a search are large, only a portion of the results
486
+ # are returned, and a `nextToken` pagination token is returned in the
487
+ # response. To retrieve the next batch of results, reissue the search
488
+ # request and include the returned token. When all results have been
489
+ # returned, the response does not contain a pagination token value.
490
+ #
491
+ # @option params [Integer] :max_results
492
+ # The maximum number of items to return in one batch, between 10 and
493
+ # 100, inclusive.
494
+ #
495
+ # @return [Types::DescribeAffectedEntitiesForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
496
+ #
497
+ # * {Types::DescribeAffectedEntitiesForOrganizationResponse#entities #entities} => Array&lt;Types::AffectedEntity&gt;
498
+ # * {Types::DescribeAffectedEntitiesForOrganizationResponse#failed_set #failed_set} => Array&lt;Types::OrganizationAffectedEntitiesErrorItem&gt;
499
+ # * {Types::DescribeAffectedEntitiesForOrganizationResponse#next_token #next_token} => String
500
+ #
501
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
502
+ #
503
+ # @example Request syntax with placeholder values
504
+ #
505
+ # resp = client.describe_affected_entities_for_organization({
506
+ # organization_entity_filters: [ # required
507
+ # {
508
+ # event_arn: "eventArn", # required
509
+ # aws_account_id: "accountId",
510
+ # },
511
+ # ],
512
+ # locale: "locale",
513
+ # next_token: "nextToken",
514
+ # max_results: 1,
515
+ # })
516
+ #
517
+ # @example Response structure
518
+ #
519
+ # resp.entities #=> Array
520
+ # resp.entities[0].entity_arn #=> String
521
+ # resp.entities[0].event_arn #=> String
522
+ # resp.entities[0].entity_value #=> String
523
+ # resp.entities[0].entity_url #=> String
524
+ # resp.entities[0].aws_account_id #=> String
525
+ # resp.entities[0].last_updated_time #=> Time
526
+ # resp.entities[0].status_code #=> String, one of "IMPAIRED", "UNIMPAIRED", "UNKNOWN"
527
+ # resp.entities[0].tags #=> Hash
528
+ # resp.entities[0].tags["tagKey"] #=> String
529
+ # resp.failed_set #=> Array
530
+ # resp.failed_set[0].aws_account_id #=> String
531
+ # resp.failed_set[0].event_arn #=> String
532
+ # resp.failed_set[0].error_name #=> String
533
+ # resp.failed_set[0].error_message #=> String
534
+ # resp.next_token #=> String
535
+ #
536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganization AWS API Documentation
537
+ #
538
+ # @overload describe_affected_entities_for_organization(params = {})
539
+ # @param [Hash] params ({})
540
+ def describe_affected_entities_for_organization(params = {}, options = {})
541
+ req = build_request(:describe_affected_entities_for_organization, params)
542
+ req.send_request(options)
543
+ end
544
+
349
545
  # Returns the number of entities that are affected by each of the
350
546
  # specified events. If no events are specified, the counts of all
351
547
  # affected entities are returned.
@@ -406,6 +602,8 @@ module Aws::Health
406
602
  # * {Types::DescribeEventAggregatesResponse#event_aggregates #event_aggregates} => Array&lt;Types::EventAggregate&gt;
407
603
  # * {Types::DescribeEventAggregatesResponse#next_token #next_token} => String
408
604
  #
605
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
606
+ #
409
607
  # @example Request syntax with placeholder values
410
608
  #
411
609
  # resp = client.describe_event_aggregates({
@@ -465,8 +663,8 @@ module Aws::Health
465
663
  end
466
664
 
467
665
  # Returns detailed information about one or more specified events.
468
- # Information includes standard event data (region, service, etc., as
469
- # returned by DescribeEvents), a detailed event description, and
666
+ # Information includes standard event data (region, service, and so on,
667
+ # as returned by DescribeEvents), a detailed event description, and
470
668
  # possible additional metadata that depends upon the nature of the
471
669
  # event. Affected entities are not included; to retrieve those, use the
472
670
  # DescribeAffectedEntities operation.
@@ -508,6 +706,7 @@ module Aws::Health
508
706
  # resp.successful_set[0].event.end_time #=> Time
509
707
  # resp.successful_set[0].event.last_updated_time #=> Time
510
708
  # resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
709
+ # resp.successful_set[0].event.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
511
710
  # resp.successful_set[0].event_description.latest_description #=> String
512
711
  # resp.successful_set[0].event_metadata #=> Hash
513
712
  # resp.successful_set[0].event_metadata["metadataKey"] #=> String
@@ -525,6 +724,77 @@ module Aws::Health
525
724
  req.send_request(options)
526
725
  end
527
726
 
727
+ # Returns detailed information about one or more specified events for
728
+ # one or more accounts in your organization. Information includes
729
+ # standard event data (Region, service, and so on, as returned by
730
+ # DescribeEventsForOrganization, a detailed event description, and
731
+ # possible additional metadata that depends upon the nature of the
732
+ # event. Affected entities are not included; to retrieve those, use the
733
+ # DescribeAffectedEntitiesForOrganization operation.
734
+ #
735
+ # Before you can call this operation, you must first enable AWS Health
736
+ # to work with AWS Organizations. To do this, call the
737
+ # EnableHealthServiceAccessForOrganization operation from your
738
+ # organization's master account.
739
+ #
740
+ # @option params [required, Array<Types::EventAccountFilter>] :organization_event_detail_filters
741
+ # A set of JSON elements that includes the `awsAccountId` and the
742
+ # `eventArn`.
743
+ #
744
+ # @option params [String] :locale
745
+ # The locale (language) to return information in. English (en) is the
746
+ # default and the only supported value at this time.
747
+ #
748
+ # @return [Types::DescribeEventDetailsForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
749
+ #
750
+ # * {Types::DescribeEventDetailsForOrganizationResponse#successful_set #successful_set} => Array&lt;Types::OrganizationEventDetails&gt;
751
+ # * {Types::DescribeEventDetailsForOrganizationResponse#failed_set #failed_set} => Array&lt;Types::OrganizationEventDetailsErrorItem&gt;
752
+ #
753
+ # @example Request syntax with placeholder values
754
+ #
755
+ # resp = client.describe_event_details_for_organization({
756
+ # organization_event_detail_filters: [ # required
757
+ # {
758
+ # event_arn: "eventArn", # required
759
+ # aws_account_id: "accountId",
760
+ # },
761
+ # ],
762
+ # locale: "locale",
763
+ # })
764
+ #
765
+ # @example Response structure
766
+ #
767
+ # resp.successful_set #=> Array
768
+ # resp.successful_set[0].aws_account_id #=> String
769
+ # resp.successful_set[0].event.arn #=> String
770
+ # resp.successful_set[0].event.service #=> String
771
+ # resp.successful_set[0].event.event_type_code #=> String
772
+ # resp.successful_set[0].event.event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
773
+ # resp.successful_set[0].event.region #=> String
774
+ # resp.successful_set[0].event.availability_zone #=> String
775
+ # resp.successful_set[0].event.start_time #=> Time
776
+ # resp.successful_set[0].event.end_time #=> Time
777
+ # resp.successful_set[0].event.last_updated_time #=> Time
778
+ # resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
779
+ # resp.successful_set[0].event.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
780
+ # resp.successful_set[0].event_description.latest_description #=> String
781
+ # resp.successful_set[0].event_metadata #=> Hash
782
+ # resp.successful_set[0].event_metadata["metadataKey"] #=> String
783
+ # resp.failed_set #=> Array
784
+ # resp.failed_set[0].aws_account_id #=> String
785
+ # resp.failed_set[0].event_arn #=> String
786
+ # resp.failed_set[0].error_name #=> String
787
+ # resp.failed_set[0].error_message #=> String
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganization AWS API Documentation
790
+ #
791
+ # @overload describe_event_details_for_organization(params = {})
792
+ # @param [Hash] params ({})
793
+ def describe_event_details_for_organization(params = {}, options = {})
794
+ req = build_request(:describe_event_details_for_organization, params)
795
+ req.send_request(options)
796
+ end
797
+
528
798
  # Returns the event types that meet the specified filter criteria. If no
529
799
  # filter criteria are specified, all event types are returned, in no
530
800
  # particular order.
@@ -552,6 +822,8 @@ module Aws::Health
552
822
  # * {Types::DescribeEventTypesResponse#event_types #event_types} => Array&lt;Types::EventType&gt;
553
823
  # * {Types::DescribeEventTypesResponse#next_token #next_token} => String
554
824
  #
825
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
826
+ #
555
827
  # @example Request syntax with placeholder values
556
828
  #
557
829
  # resp = client.describe_event_types({
@@ -614,6 +886,8 @@ module Aws::Health
614
886
  # * {Types::DescribeEventsResponse#events #events} => Array&lt;Types::Event&gt;
615
887
  # * {Types::DescribeEventsResponse#next_token #next_token} => String
616
888
  #
889
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
890
+ #
617
891
  # @example Request syntax with placeholder values
618
892
  #
619
893
  # resp = client.describe_events({
@@ -669,6 +943,7 @@ module Aws::Health
669
943
  # resp.events[0].end_time #=> Time
670
944
  # resp.events[0].last_updated_time #=> Time
671
945
  # resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
946
+ # resp.events[0].event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
672
947
  # resp.next_token #=> String
673
948
  #
674
949
  # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEvents AWS API Documentation
@@ -680,6 +955,162 @@ module Aws::Health
680
955
  req.send_request(options)
681
956
  end
682
957
 
958
+ # Returns information about events across your organization in AWS
959
+ # Organizations, meeting the specified filter criteria. Events are
960
+ # returned in a summary form and do not include the accounts impacted,
961
+ # detailed description, any additional metadata that depends on the
962
+ # event type, or any affected resources. To retrieve that information,
963
+ # use the DescribeAffectedAccountsForOrganization,
964
+ # DescribeEventDetailsForOrganization, and
965
+ # DescribeAffectedEntitiesForOrganization operations.
966
+ #
967
+ # If no filter criteria are specified, all events across your
968
+ # organization are returned. Results are sorted by `lastModifiedTime`,
969
+ # starting with the most recent.
970
+ #
971
+ # Before you can call this operation, you must first enable Health to
972
+ # work with AWS Organizations. To do this, call the
973
+ # EnableHealthServiceAccessForOrganization operation from your
974
+ # organization's master account.
975
+ #
976
+ # @option params [Types::OrganizationEventFilter] :filter
977
+ # Values to narrow the results returned.
978
+ #
979
+ # @option params [String] :next_token
980
+ # If the results of a search are large, only a portion of the results
981
+ # are returned, and a `nextToken` pagination token is returned in the
982
+ # response. To retrieve the next batch of results, reissue the search
983
+ # request and include the returned token. When all results have been
984
+ # returned, the response does not contain a pagination token value.
985
+ #
986
+ # @option params [Integer] :max_results
987
+ # The maximum number of items to return in one batch, between 10 and
988
+ # 100, inclusive.
989
+ #
990
+ # @option params [String] :locale
991
+ # The locale (language) to return information in. English (en) is the
992
+ # default and the only supported value at this time.
993
+ #
994
+ # @return [Types::DescribeEventsForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
995
+ #
996
+ # * {Types::DescribeEventsForOrganizationResponse#events #events} => Array&lt;Types::OrganizationEvent&gt;
997
+ # * {Types::DescribeEventsForOrganizationResponse#next_token #next_token} => String
998
+ #
999
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1000
+ #
1001
+ # @example Request syntax with placeholder values
1002
+ #
1003
+ # resp = client.describe_events_for_organization({
1004
+ # filter: {
1005
+ # event_type_codes: ["eventType"],
1006
+ # aws_account_ids: ["accountId"],
1007
+ # services: ["service"],
1008
+ # regions: ["region"],
1009
+ # start_time: {
1010
+ # from: Time.now,
1011
+ # to: Time.now,
1012
+ # },
1013
+ # end_time: {
1014
+ # from: Time.now,
1015
+ # to: Time.now,
1016
+ # },
1017
+ # last_updated_time: {
1018
+ # from: Time.now,
1019
+ # to: Time.now,
1020
+ # },
1021
+ # entity_arns: ["entityArn"],
1022
+ # entity_values: ["entityValue"],
1023
+ # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
1024
+ # event_status_codes: ["open"], # accepts open, closed, upcoming
1025
+ # },
1026
+ # next_token: "nextToken",
1027
+ # max_results: 1,
1028
+ # locale: "locale",
1029
+ # })
1030
+ #
1031
+ # @example Response structure
1032
+ #
1033
+ # resp.events #=> Array
1034
+ # resp.events[0].arn #=> String
1035
+ # resp.events[0].service #=> String
1036
+ # resp.events[0].event_type_code #=> String
1037
+ # resp.events[0].event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
1038
+ # resp.events[0].event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
1039
+ # resp.events[0].region #=> String
1040
+ # resp.events[0].start_time #=> Time
1041
+ # resp.events[0].end_time #=> Time
1042
+ # resp.events[0].last_updated_time #=> Time
1043
+ # resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
1044
+ # resp.next_token #=> String
1045
+ #
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganization AWS API Documentation
1047
+ #
1048
+ # @overload describe_events_for_organization(params = {})
1049
+ # @param [Hash] params ({})
1050
+ def describe_events_for_organization(params = {}, options = {})
1051
+ req = build_request(:describe_events_for_organization, params)
1052
+ req.send_request(options)
1053
+ end
1054
+
1055
+ # This operation provides status information on enabling or disabling
1056
+ # AWS Health to work with your organization. To call this operation, you
1057
+ # must sign in as an IAM user, assume an IAM role, or sign in as the
1058
+ # root user (not recommended) in the organization's master account.
1059
+ #
1060
+ # @return [Types::DescribeHealthServiceStatusForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1061
+ #
1062
+ # * {Types::DescribeHealthServiceStatusForOrganizationResponse#health_service_access_status_for_organization #health_service_access_status_for_organization} => String
1063
+ #
1064
+ # @example Response structure
1065
+ #
1066
+ # resp.health_service_access_status_for_organization #=> String
1067
+ #
1068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeHealthServiceStatusForOrganization AWS API Documentation
1069
+ #
1070
+ # @overload describe_health_service_status_for_organization(params = {})
1071
+ # @param [Hash] params ({})
1072
+ def describe_health_service_status_for_organization(params = {}, options = {})
1073
+ req = build_request(:describe_health_service_status_for_organization, params)
1074
+ req.send_request(options)
1075
+ end
1076
+
1077
+ # Calling this operation disables Health from working with AWS
1078
+ # Organizations. This does not remove the Service Linked Role (SLR) from
1079
+ # the the master account in your organization. Use the IAM console, API,
1080
+ # or AWS CLI to remove the SLR if desired. To call this operation, you
1081
+ # must sign in as an IAM user, assume an IAM role, or sign in as the
1082
+ # root user (not recommended) in the organization's master account.
1083
+ #
1084
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1085
+ #
1086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DisableHealthServiceAccessForOrganization AWS API Documentation
1087
+ #
1088
+ # @overload disable_health_service_access_for_organization(params = {})
1089
+ # @param [Hash] params ({})
1090
+ def disable_health_service_access_for_organization(params = {}, options = {})
1091
+ req = build_request(:disable_health_service_access_for_organization, params)
1092
+ req.send_request(options)
1093
+ end
1094
+
1095
+ # Calling this operation enables AWS Health to work with AWS
1096
+ # Organizations. This applies a Service Linked Role (SLR) to the master
1097
+ # account in the organization. To learn more about the steps in this
1098
+ # process, visit enabling service access for AWS Health in AWS
1099
+ # Organizations. To call this operation, you must sign in as an IAM
1100
+ # user, assume an IAM role, or sign in as the root user (not
1101
+ # recommended) in the organization's master account.
1102
+ #
1103
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1104
+ #
1105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EnableHealthServiceAccessForOrganization AWS API Documentation
1106
+ #
1107
+ # @overload enable_health_service_access_for_organization(params = {})
1108
+ # @param [Hash] params ({})
1109
+ def enable_health_service_access_for_organization(params = {}, options = {})
1110
+ req = build_request(:enable_health_service_access_for_organization, params)
1111
+ req.send_request(options)
1112
+ end
1113
+
683
1114
  # @!endgroup
684
1115
 
685
1116
  # @param params ({})
@@ -693,7 +1124,7 @@ module Aws::Health
693
1124
  params: params,
694
1125
  config: config)
695
1126
  context[:gem_name] = 'aws-sdk-health'
696
- context[:gem_version] = '1.20.0'
1127
+ context[:gem_version] = '1.25.0'
697
1128
  Seahorse::Client::Request.new(handlers, context)
698
1129
  end
699
1130