aws-sdk-health 1.41.0 → 1.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-health/client.rb +104 -92
- data/lib/aws-sdk-health/types.rb +109 -93
- data/lib/aws-sdk-health.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d246a502b07aebaea87fc64a8c6980dfcb954b0a22ac511f69aaa53f56dc3ba7
|
4
|
+
data.tar.gz: fd71dc5bd195c8f4fdf70fa8bca4403fe87b185cdb76f232b3640a6448a37fa0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 54f389fc30960ba882c2f5864787423eb31414d48a69fa7990b72635af1e16b904e312f9dac7b65317625c9bfb279f2b5fa377899c1f1481d32980daef0cfd9b
|
7
|
+
data.tar.gz: 0f13532f5d07b0d2d2d1ff324193fc11e5f7a327a2e8e34c90a409c2c0b37bb2df2dec6e6eb31820c790a08f3dd3821b46ef15a10720039f46aa7b7a775f4f5d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.45.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.44.0 (2021-12-08)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation updates for AWS Health
|
13
|
+
|
14
|
+
1.43.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.42.0 (2021-11-09)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Documentation updates for AWS Health.
|
23
|
+
|
4
24
|
1.41.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.45.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Health
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Health
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Health
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -305,7 +313,7 @@ module Aws::Health
|
|
305
313
|
# seconds to wait when opening a HTTP session before raising a
|
306
314
|
# `Timeout::Error`.
|
307
315
|
#
|
308
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
317
|
# number of seconds to wait for response data. This value can
|
310
318
|
# safely be set per-request on the session.
|
311
319
|
#
|
@@ -321,6 +329,9 @@ module Aws::Health
|
|
321
329
|
# disables this behaviour. This value can safely be set per
|
322
330
|
# request on the session.
|
323
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
324
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
336
|
# HTTP debug output will be sent to the `:logger`.
|
326
337
|
#
|
@@ -346,12 +357,12 @@ module Aws::Health
|
|
346
357
|
|
347
358
|
# @!group API Operations
|
348
359
|
|
349
|
-
# Returns a list of accounts in the organization from
|
350
|
-
#
|
351
|
-
#
|
360
|
+
# Returns a list of accounts in the organization from Organizations that
|
361
|
+
# are affected by the provided event. For more information about the
|
362
|
+
# different types of Health events, see [Event][1].
|
352
363
|
#
|
353
|
-
# Before you can call this operation, you must first enable
|
354
|
-
#
|
364
|
+
# Before you can call this operation, you must first enable Health to
|
365
|
+
# work with Organizations. To do this, call the
|
355
366
|
# [EnableHealthServiceAccessForOrganization][2] operation from your
|
356
367
|
# organization's management account.
|
357
368
|
#
|
@@ -420,20 +431,20 @@ module Aws::Health
|
|
420
431
|
# Returns a list of entities that have been affected by the specified
|
421
432
|
# events, based on the specified filter criteria. Entities can refer to
|
422
433
|
# individual customer resources, groups of customer resources, or any
|
423
|
-
# other construct, depending on the
|
424
|
-
# beyond that of the affected entities, or where the
|
425
|
-
# unknown, include at least one entity indicating
|
434
|
+
# other construct, depending on the Amazon Web Services service. Events
|
435
|
+
# that have impact beyond that of the affected entities, or where the
|
436
|
+
# extent of impact is unknown, include at least one entity indicating
|
437
|
+
# this.
|
426
438
|
#
|
427
|
-
# At least one event ARN is required.
|
428
|
-
# `lastUpdatedTime` of the entity, starting with the most recent.
|
439
|
+
# At least one event ARN is required.
|
429
440
|
#
|
430
441
|
# <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
|
431
442
|
# parameter in the next request to return more results.
|
432
443
|
#
|
433
444
|
# * This operation supports resource-level permissions. You can use this
|
434
|
-
# operation to allow or deny access to specific
|
445
|
+
# operation to allow or deny access to specific Health events. For
|
435
446
|
# more information, see [Resource- and action-based conditions][1] in
|
436
|
-
# the *
|
447
|
+
# the *Health User Guide*.
|
437
448
|
#
|
438
449
|
# </note>
|
439
450
|
#
|
@@ -516,17 +527,16 @@ module Aws::Health
|
|
516
527
|
end
|
517
528
|
|
518
529
|
# Returns a list of entities that have been affected by one or more
|
519
|
-
# events for one or more accounts in your organization in
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
530
|
+
# events for one or more accounts in your organization in Organizations,
|
531
|
+
# based on the filter criteria. Entities can refer to individual
|
532
|
+
# customer resources, groups of customer resources, or any other
|
533
|
+
# construct, depending on the Amazon Web Services service.
|
523
534
|
#
|
524
535
|
# At least one event Amazon Resource Name (ARN) and account ID are
|
525
|
-
# required.
|
526
|
-
# starting with the most recent.
|
536
|
+
# required.
|
527
537
|
#
|
528
|
-
# Before you can call this operation, you must first enable
|
529
|
-
#
|
538
|
+
# Before you can call this operation, you must first enable Health to
|
539
|
+
# work with Organizations. To do this, call the
|
530
540
|
# [EnableHealthServiceAccessForOrganization][1] operation from your
|
531
541
|
# organization's management account.
|
532
542
|
#
|
@@ -534,9 +544,9 @@ module Aws::Health
|
|
534
544
|
# parameter in the next request to return more results.
|
535
545
|
#
|
536
546
|
# * This operation doesn't support resource-level permissions. You
|
537
|
-
# can't use this operation to allow or deny access to specific
|
538
|
-
#
|
539
|
-
# conditions][2] in the *
|
547
|
+
# can't use this operation to allow or deny access to specific Health
|
548
|
+
# events. For more information, see [Resource- and action-based
|
549
|
+
# conditions][2] in the *Health User Guide*.
|
540
550
|
#
|
541
551
|
# </note>
|
542
552
|
#
|
@@ -615,8 +625,7 @@ module Aws::Health
|
|
615
625
|
end
|
616
626
|
|
617
627
|
# Returns the number of entities that are affected by each of the
|
618
|
-
# specified events.
|
619
|
-
# affected entities are returned.
|
628
|
+
# specified events.
|
620
629
|
#
|
621
630
|
# @option params [Array<String>] :event_arns
|
622
631
|
# A list of event ARNs (unique identifiers). For example:
|
@@ -740,19 +749,20 @@ module Aws::Health
|
|
740
749
|
end
|
741
750
|
|
742
751
|
# Returns detailed information about one or more specified events.
|
743
|
-
# Information includes standard event data (
|
744
|
-
# on, as returned by [DescribeEvents][1]), a detailed
|
745
|
-
# and possible additional metadata that depends upon
|
746
|
-
# event. Affected entities are not included. To
|
747
|
-
# use the [DescribeAffectedEntities][2]
|
752
|
+
# Information includes standard event data (Amazon Web Services Region,
|
753
|
+
# service, and so on, as returned by [DescribeEvents][1]), a detailed
|
754
|
+
# event description, and possible additional metadata that depends upon
|
755
|
+
# the nature of the event. Affected entities are not included. To
|
756
|
+
# retrieve the entities, use the [DescribeAffectedEntities][2]
|
757
|
+
# operation.
|
748
758
|
#
|
749
759
|
# If a specified event can't be retrieved, an error message is returned
|
750
760
|
# for that event.
|
751
761
|
#
|
752
762
|
# <note markdown="1"> This operation supports resource-level permissions. You can use this
|
753
|
-
# operation to allow or deny access to specific
|
754
|
-
#
|
755
|
-
#
|
763
|
+
# operation to allow or deny access to specific Health events. For more
|
764
|
+
# information, see [Resource- and action-based conditions][3] in the
|
765
|
+
# *Health User Guide*.
|
756
766
|
#
|
757
767
|
# </note>
|
758
768
|
#
|
@@ -815,15 +825,16 @@ module Aws::Health
|
|
815
825
|
end
|
816
826
|
|
817
827
|
# Returns detailed information about one or more specified events for
|
818
|
-
# one or more
|
819
|
-
# includes standard event data (such as the
|
820
|
-
# event description, and (depending on
|
821
|
-
# This operation doesn't return affected
|
822
|
-
# resources related to the event. To return
|
828
|
+
# one or more Amazon Web Services accounts in your organization. This
|
829
|
+
# information includes standard event data (such as the Amazon Web
|
830
|
+
# Services Region and service), an event description, and (depending on
|
831
|
+
# the event) possible metadata. This operation doesn't return affected
|
832
|
+
# entities, such as the resources related to the event. To return
|
833
|
+
# affected entities, use the
|
823
834
|
# [DescribeAffectedEntitiesForOrganization][1] operation.
|
824
835
|
#
|
825
|
-
# <note markdown="1"> Before you can call this operation, you must first enable
|
826
|
-
#
|
836
|
+
# <note markdown="1"> Before you can call this operation, you must first enable Health to
|
837
|
+
# work with Organizations. To do this, call the
|
827
838
|
# [EnableHealthServiceAccessForOrganization][2] operation from your
|
828
839
|
# organization's management account.
|
829
840
|
#
|
@@ -831,26 +842,25 @@ module Aws::Health
|
|
831
842
|
#
|
832
843
|
# When you call the `DescribeEventDetailsForOrganization` operation,
|
833
844
|
# specify the `organizationEventDetailFilters` object in the request.
|
834
|
-
# Depending on the
|
835
|
-
# differences:
|
845
|
+
# Depending on the Health event type, note the following differences:
|
836
846
|
#
|
837
847
|
# * To return event details for a public event, you must specify a null
|
838
848
|
# value for the `awsAccountId` parameter. If you specify an account ID
|
839
|
-
# for a public event,
|
840
|
-
#
|
849
|
+
# for a public event, Health returns an error message because public
|
850
|
+
# events aren't specific to an account.
|
841
851
|
#
|
842
852
|
# * To return event details for an event that is specific to an account
|
843
853
|
# in your organization, you must specify the `awsAccountId` parameter
|
844
|
-
# in the request. If you don't specify an account ID,
|
845
|
-
#
|
846
|
-
#
|
854
|
+
# in the request. If you don't specify an account ID, Health returns
|
855
|
+
# an error message because the event is specific to an account in your
|
856
|
+
# organization.
|
847
857
|
#
|
848
858
|
# For more information, see [Event][3].
|
849
859
|
#
|
850
860
|
# <note markdown="1"> This operation doesn't support resource-level permissions. You can't
|
851
|
-
# use this operation to allow or deny access to specific
|
852
|
-
#
|
853
|
-
#
|
861
|
+
# use this operation to allow or deny access to specific Health events.
|
862
|
+
# For more information, see [Resource- and action-based conditions][4]
|
863
|
+
# in the *Health User Guide*.
|
854
864
|
#
|
855
865
|
# </note>
|
856
866
|
#
|
@@ -920,9 +930,9 @@ module Aws::Health
|
|
920
930
|
end
|
921
931
|
|
922
932
|
# Returns the event types that meet the specified filter criteria. You
|
923
|
-
# can use this API operation to find information about the
|
924
|
-
#
|
925
|
-
# for each event appears in the [EventType][1] object.
|
933
|
+
# can use this API operation to find information about the Health event,
|
934
|
+
# such as the category, Amazon Web Services service, and event code. The
|
935
|
+
# metadata for each event appears in the [EventType][1] object.
|
926
936
|
#
|
927
937
|
# If you don't specify a filter criteria, the API operation returns all
|
928
938
|
# event types, in no particular order.
|
@@ -1002,13 +1012,13 @@ module Aws::Health
|
|
1002
1012
|
# are sorted by `lastModifiedTime`, starting with the most recent event.
|
1003
1013
|
#
|
1004
1014
|
# <note markdown="1"> * When you call the `DescribeEvents` operation and specify an entity
|
1005
|
-
# for the `entityValues` parameter,
|
1006
|
-
#
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
1010
|
-
#
|
1011
|
-
#
|
1015
|
+
# for the `entityValues` parameter, Health might return public events
|
1016
|
+
# that aren't specific to that resource. For example, if you call
|
1017
|
+
# `DescribeEvents` and specify an ID for an Amazon Elastic Compute
|
1018
|
+
# Cloud (Amazon EC2) instance, Health might return events that aren't
|
1019
|
+
# specific to that resource or service. To get events that are
|
1020
|
+
# specific to a service, use the `services` parameter in the `filter`
|
1021
|
+
# object. For more information, see [Event][3].
|
1012
1022
|
#
|
1013
1023
|
# * This API operation uses pagination. Specify the `nextToken`
|
1014
1024
|
# parameter in the next request to return more results.
|
@@ -1113,7 +1123,7 @@ module Aws::Health
|
|
1113
1123
|
req.send_request(options)
|
1114
1124
|
end
|
1115
1125
|
|
1116
|
-
# Returns information about events across your organization in
|
1126
|
+
# Returns information about events across your organization in
|
1117
1127
|
# Organizations. You can use the`filters` parameter to specify the
|
1118
1128
|
# events that you want to return. Events are returned in a summary form
|
1119
1129
|
# and don't include the affected accounts, detailed description, any
|
@@ -1130,11 +1140,11 @@ module Aws::Health
|
|
1130
1140
|
# returns all events across your organization. Results are sorted by
|
1131
1141
|
# `lastModifiedTime`, starting with the most recent event.
|
1132
1142
|
#
|
1133
|
-
# For more information about the different types of
|
1134
|
-
#
|
1143
|
+
# For more information about the different types of Health events, see
|
1144
|
+
# [Event][4].
|
1135
1145
|
#
|
1136
|
-
# Before you can call this operation, you must first enable
|
1137
|
-
#
|
1146
|
+
# Before you can call this operation, you must first enable Health to
|
1147
|
+
# work with Organizations. To do this, call the
|
1138
1148
|
# [EnableHealthServiceAccessForOrganization][5] operation from your
|
1139
1149
|
# organization's management account.
|
1140
1150
|
#
|
@@ -1231,7 +1241,7 @@ module Aws::Health
|
|
1231
1241
|
end
|
1232
1242
|
|
1233
1243
|
# This operation provides status information on enabling or disabling
|
1234
|
-
#
|
1244
|
+
# Health to work with your organization. To call this operation, you
|
1235
1245
|
# must sign in as an IAM user, assume an IAM role, or sign in as the
|
1236
1246
|
# root user (not recommended) in the organization's management account.
|
1237
1247
|
#
|
@@ -1252,25 +1262,26 @@ module Aws::Health
|
|
1252
1262
|
req.send_request(options)
|
1253
1263
|
end
|
1254
1264
|
|
1255
|
-
# Disables
|
1256
|
-
# operation, you must sign in as an
|
1257
|
-
#
|
1265
|
+
# Disables Health from working with Organizations. To call this
|
1266
|
+
# operation, you must sign in as an Identity and Access Management (IAM)
|
1267
|
+
# user, assume an IAM role, or sign in as the root user (not
|
1258
1268
|
# recommended) in the organization's management account. For more
|
1259
|
-
# information, see [Aggregating
|
1260
|
-
#
|
1269
|
+
# information, see [Aggregating Health events][1] in the *Health User
|
1270
|
+
# Guide*.
|
1261
1271
|
#
|
1262
1272
|
# This operation doesn't remove the service-linked role from the
|
1263
1273
|
# management account in your organization. You must use the IAM console,
|
1264
|
-
# API, or
|
1265
|
-
#
|
1266
|
-
#
|
1274
|
+
# API, or Command Line Interface (CLI) to remove the service-linked
|
1275
|
+
# role. For more information, see [Deleting a Service-Linked Role][2] in
|
1276
|
+
# the *IAM User Guide*.
|
1267
1277
|
#
|
1268
1278
|
# <note markdown="1"> You can also disable the organizational feature by using the
|
1269
1279
|
# Organizations [DisableAWSServiceAccess][3] API operation. After you
|
1270
|
-
# call this operation,
|
1271
|
-
#
|
1272
|
-
# operations for organizational view,
|
1273
|
-
# Health continues to aggregate health events for your
|
1280
|
+
# call this operation, Health stops aggregating events for all other
|
1281
|
+
# Amazon Web Services accounts in your organization. If you call the
|
1282
|
+
# Health API operations for organizational view, Health returns an
|
1283
|
+
# error. Health continues to aggregate health events for your Amazon Web
|
1284
|
+
# Services account.
|
1274
1285
|
#
|
1275
1286
|
# </note>
|
1276
1287
|
#
|
@@ -1291,30 +1302,31 @@ module Aws::Health
|
|
1291
1302
|
req.send_request(options)
|
1292
1303
|
end
|
1293
1304
|
|
1294
|
-
# Enables
|
1295
|
-
# organizational view feature to aggregate events from all
|
1296
|
-
# in your organization in a centralized location.
|
1305
|
+
# Enables Health to work with Organizations. You can use the
|
1306
|
+
# organizational view feature to aggregate events from all Amazon Web
|
1307
|
+
# Services accounts in your organization in a centralized location.
|
1297
1308
|
#
|
1298
1309
|
# This operation also creates a service-linked role for the management
|
1299
1310
|
# account in the organization.
|
1300
1311
|
#
|
1301
1312
|
# <note markdown="1"> To call this operation, you must meet the following requirements:
|
1302
1313
|
#
|
1303
|
-
# * You must have a Business or Enterprise Support
|
1304
|
-
# Support][1] to use the
|
1305
|
-
#
|
1306
|
-
#
|
1314
|
+
# * You must have a Business, Enterprise On-Ramp, or Enterprise Support
|
1315
|
+
# plan from [Amazon Web Services Support][1] to use the Health API. If
|
1316
|
+
# you call the Health API from an Amazon Web Services account that
|
1317
|
+
# doesn't have a Business, Enterprise On-Ramp, or Enterprise Support
|
1318
|
+
# plan, you receive a `SubscriptionRequiredException` error.
|
1307
1319
|
#
|
1308
1320
|
# * You must have permission to call this operation from the
|
1309
1321
|
# organization's management account. For example IAM policies, see
|
1310
|
-
# [
|
1322
|
+
# [Health identity-based policy examples][2].
|
1311
1323
|
#
|
1312
1324
|
# </note>
|
1313
1325
|
#
|
1314
1326
|
# If you don't have the required support plan, you can instead use the
|
1315
|
-
#
|
1316
|
-
# information, see [Aggregating
|
1317
|
-
#
|
1327
|
+
# Health console to enable the organizational view feature. For more
|
1328
|
+
# information, see [Aggregating Health events][3] in the *Health User
|
1329
|
+
# Guide*.
|
1318
1330
|
#
|
1319
1331
|
#
|
1320
1332
|
#
|
@@ -1346,7 +1358,7 @@ module Aws::Health
|
|
1346
1358
|
params: params,
|
1347
1359
|
config: config)
|
1348
1360
|
context[:gem_name] = 'aws-sdk-health'
|
1349
|
-
context[:gem_version] = '1.
|
1361
|
+
context[:gem_version] = '1.45.0'
|
1350
1362
|
Seahorse::Client::Request.new(handlers, context)
|
1351
1363
|
end
|
1352
1364
|
|
data/lib/aws-sdk-health/types.rb
CHANGED
@@ -38,7 +38,8 @@ module Aws::Health
|
|
38
38
|
# @return [String]
|
39
39
|
#
|
40
40
|
# @!attribute [rw] aws_account_id
|
41
|
-
# The 12-digit
|
41
|
+
# The 12-digit Amazon Web Services account number that contains the
|
42
|
+
# affected entity.
|
42
43
|
# @return [String]
|
43
44
|
#
|
44
45
|
# @!attribute [rw] last_updated_time
|
@@ -179,17 +180,18 @@ module Aws::Health
|
|
179
180
|
# @return [Array<String>]
|
180
181
|
#
|
181
182
|
# @!attribute [rw] event_scope_code
|
182
|
-
# This parameter specifies if the
|
183
|
-
# service event or an account-specific event.
|
183
|
+
# This parameter specifies if the Health event is a public Amazon Web
|
184
|
+
# Services service event or an account-specific event.
|
184
185
|
#
|
185
186
|
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
186
187
|
# `affectedAccounts` value is always empty.
|
187
188
|
#
|
188
189
|
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
189
|
-
# `affectedAccounts` value lists the affected
|
190
|
-
# organization. For example, if an event affects a
|
191
|
-
# Amazon Elastic Compute Cloud and you have
|
192
|
-
# that service, those account IDs
|
190
|
+
# `affectedAccounts` value lists the affected Amazon Web Services
|
191
|
+
# accounts in your organization. For example, if an event affects a
|
192
|
+
# service such as Amazon Elastic Compute Cloud and you have Amazon
|
193
|
+
# Web Services accounts that use that service, those account IDs
|
194
|
+
# appear in the response.
|
193
195
|
#
|
194
196
|
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
195
197
|
# you specified in the request is invalid or doesn't exist.
|
@@ -853,8 +855,8 @@ module Aws::Health
|
|
853
855
|
end
|
854
856
|
|
855
857
|
# @!attribute [rw] health_service_access_status_for_organization
|
856
|
-
# Information about the status of enabling or disabling
|
857
|
-
#
|
858
|
+
# Information about the status of enabling or disabling the Health
|
859
|
+
# organizational view feature in your organization.
|
858
860
|
#
|
859
861
|
# Valid values are `ENABLED | DISABLED | PENDING`.
|
860
862
|
# @return [String]
|
@@ -898,12 +900,12 @@ module Aws::Health
|
|
898
900
|
include Aws::Structure
|
899
901
|
end
|
900
902
|
|
901
|
-
# The values to use to filter results from the
|
902
|
-
# operation.
|
903
|
+
# The values to use to filter results from the
|
904
|
+
# [DescribeAffectedEntities][1] operation.
|
903
905
|
#
|
904
906
|
#
|
905
907
|
#
|
906
|
-
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/
|
908
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
|
907
909
|
#
|
908
910
|
# @note When making an API call, you may pass EntityFilter
|
909
911
|
# data as a hash:
|
@@ -971,20 +973,20 @@ module Aws::Health
|
|
971
973
|
include Aws::Structure
|
972
974
|
end
|
973
975
|
|
974
|
-
# Summary information about an
|
976
|
+
# Summary information about an Health event.
|
975
977
|
#
|
976
|
-
#
|
978
|
+
# Health events can be public or account-specific:
|
977
979
|
#
|
978
980
|
# * *Public events* might be service events that are not specific to an
|
979
|
-
#
|
980
|
-
#
|
981
|
-
# use services or resources in that Region.
|
981
|
+
# Amazon Web Services account. For example, if there is an issue with
|
982
|
+
# an Amazon Web Services Region, Health provides information about the
|
983
|
+
# event, even if you don't use services or resources in that Region.
|
982
984
|
#
|
983
|
-
# * *Account-specific* events are specific to either your
|
984
|
-
# an account in your organization. For example, if
|
985
|
-
# with Amazon Elastic Compute Cloud in a Region that
|
986
|
-
# Health provides information about the event and the
|
987
|
-
# resources in the account.
|
985
|
+
# * *Account-specific* events are specific to either your Amazon Web
|
986
|
+
# Services account or an account in your organization. For example, if
|
987
|
+
# there's an issue with Amazon Elastic Compute Cloud in a Region that
|
988
|
+
# you use, Health provides information about the event and the
|
989
|
+
# affected resources in the account.
|
988
990
|
#
|
989
991
|
# You can determine if an event is public or account-specific by using
|
990
992
|
# the `eventScopeCode` parameter. For more information, see
|
@@ -1005,8 +1007,8 @@ module Aws::Health
|
|
1005
1007
|
# @return [String]
|
1006
1008
|
#
|
1007
1009
|
# @!attribute [rw] service
|
1008
|
-
# The
|
1009
|
-
# `RDS`.
|
1010
|
+
# The Amazon Web Services service that is affected by the event. For
|
1011
|
+
# example, `EC2`, `RDS`.
|
1010
1012
|
# @return [String]
|
1011
1013
|
#
|
1012
1014
|
# @!attribute [rw] event_type_code
|
@@ -1016,16 +1018,18 @@ module Aws::Health
|
|
1016
1018
|
# @return [String]
|
1017
1019
|
#
|
1018
1020
|
# @!attribute [rw] event_type_category
|
1019
|
-
#
|
1020
|
-
# `
|
1021
|
+
# A list of event type category codes. Possible values are `issue`,
|
1022
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1023
|
+
# `investigation` value isn't supported at this time.
|
1021
1024
|
# @return [String]
|
1022
1025
|
#
|
1023
1026
|
# @!attribute [rw] region
|
1024
|
-
# The
|
1027
|
+
# The Amazon Web Services Region name of the event.
|
1025
1028
|
# @return [String]
|
1026
1029
|
#
|
1027
1030
|
# @!attribute [rw] availability_zone
|
1028
|
-
# The
|
1031
|
+
# The Amazon Web Services Availability Zone of the event. For example,
|
1032
|
+
# us-east-1a.
|
1029
1033
|
# @return [String]
|
1030
1034
|
#
|
1031
1035
|
# @!attribute [rw] start_time
|
@@ -1046,17 +1050,18 @@ module Aws::Health
|
|
1046
1050
|
# @return [String]
|
1047
1051
|
#
|
1048
1052
|
# @!attribute [rw] event_scope_code
|
1049
|
-
# This parameter specifies if the
|
1050
|
-
# service event or an account-specific event.
|
1053
|
+
# This parameter specifies if the Health event is a public Amazon Web
|
1054
|
+
# Services service event or an account-specific event.
|
1051
1055
|
#
|
1052
1056
|
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
1053
1057
|
# `affectedAccounts` value is always empty.
|
1054
1058
|
#
|
1055
1059
|
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
1056
|
-
# `affectedAccounts` value lists the affected
|
1057
|
-
# organization. For example, if an event affects a
|
1058
|
-
# Amazon Elastic Compute Cloud and you have
|
1059
|
-
# that service, those account IDs
|
1060
|
+
# `affectedAccounts` value lists the affected Amazon Web Services
|
1061
|
+
# accounts in your organization. For example, if an event affects a
|
1062
|
+
# service such as Amazon Elastic Compute Cloud and you have Amazon
|
1063
|
+
# Web Services accounts that use that service, those account IDs
|
1064
|
+
# appear in the response.
|
1060
1065
|
#
|
1061
1066
|
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
1062
1067
|
# you specified in the request is invalid or doesn't exist.
|
@@ -1108,8 +1113,8 @@ module Aws::Health
|
|
1108
1113
|
# @return [String]
|
1109
1114
|
#
|
1110
1115
|
# @!attribute [rw] aws_account_id
|
1111
|
-
# The 12-digit
|
1112
|
-
# entities.
|
1116
|
+
# The 12-digit Amazon Web Services account numbers that contains the
|
1117
|
+
# affected entities.
|
1113
1118
|
# @return [String]
|
1114
1119
|
#
|
1115
1120
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventAccountFilter AWS API Documentation
|
@@ -1289,16 +1294,16 @@ module Aws::Health
|
|
1289
1294
|
# @return [Array<String>]
|
1290
1295
|
#
|
1291
1296
|
# @!attribute [rw] services
|
1292
|
-
# The
|
1293
|
-
# `RDS`.
|
1297
|
+
# The Amazon Web Services services associated with the event. For
|
1298
|
+
# example, `EC2`, `RDS`.
|
1294
1299
|
# @return [Array<String>]
|
1295
1300
|
#
|
1296
1301
|
# @!attribute [rw] regions
|
1297
|
-
# A list of
|
1302
|
+
# A list of Amazon Web Services Regions.
|
1298
1303
|
# @return [Array<String>]
|
1299
1304
|
#
|
1300
1305
|
# @!attribute [rw] availability_zones
|
1301
|
-
# A list of
|
1306
|
+
# A list of Amazon Web Services Availability Zones.
|
1302
1307
|
# @return [Array<String>]
|
1303
1308
|
#
|
1304
1309
|
# @!attribute [rw] start_times
|
@@ -1323,8 +1328,9 @@ module Aws::Health
|
|
1323
1328
|
# @return [Array<String>]
|
1324
1329
|
#
|
1325
1330
|
# @!attribute [rw] event_type_categories
|
1326
|
-
# A list of event type category codes
|
1327
|
-
# `accountNotification`
|
1331
|
+
# A list of event type category codes. Possible values are `issue`,
|
1332
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1333
|
+
# `investigation` value isn't supported at this time.
|
1328
1334
|
# @return [Array<String>]
|
1329
1335
|
#
|
1330
1336
|
# @!attribute [rw] tags
|
@@ -1359,7 +1365,7 @@ module Aws::Health
|
|
1359
1365
|
include Aws::Structure
|
1360
1366
|
end
|
1361
1367
|
|
1362
|
-
# Contains the metadata about a type of event that is reported by
|
1368
|
+
# Contains the metadata about a type of event that is reported by
|
1363
1369
|
# Health. The `EventType` shows the category, service, and the event
|
1364
1370
|
# type code of the event. For example, an `issue` might be the category,
|
1365
1371
|
# `EC2` the service, and `AWS_EC2_SYSTEM_MAINTENANCE_EVENT` the event
|
@@ -1369,10 +1375,10 @@ module Aws::Health
|
|
1369
1375
|
# information about an event.
|
1370
1376
|
#
|
1371
1377
|
# You can also use the Amazon CloudWatch Events console to create a rule
|
1372
|
-
# so that you can get notified or take action when
|
1373
|
-
# specific event to your
|
1374
|
-
# for
|
1375
|
-
# Health User Guide*.
|
1378
|
+
# so that you can get notified or take action when Health delivers a
|
1379
|
+
# specific event to your Amazon Web Services account. For more
|
1380
|
+
# information, see [Monitor for Health events with Amazon CloudWatch
|
1381
|
+
# Events][2] in the *Health User Guide*.
|
1376
1382
|
#
|
1377
1383
|
#
|
1378
1384
|
#
|
@@ -1380,8 +1386,8 @@ module Aws::Health
|
|
1380
1386
|
# [2]: https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html
|
1381
1387
|
#
|
1382
1388
|
# @!attribute [rw] service
|
1383
|
-
# The
|
1384
|
-
# `RDS`.
|
1389
|
+
# The Amazon Web Services service that is affected by the event. For
|
1390
|
+
# example, `EC2`, `RDS`.
|
1385
1391
|
# @return [String]
|
1386
1392
|
#
|
1387
1393
|
# @!attribute [rw] code
|
@@ -1391,8 +1397,9 @@ module Aws::Health
|
|
1391
1397
|
# @return [String]
|
1392
1398
|
#
|
1393
1399
|
# @!attribute [rw] category
|
1394
|
-
# A list of event type category codes
|
1395
|
-
# `accountNotification`
|
1400
|
+
# A list of event type category codes. Possible values are `issue`,
|
1401
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1402
|
+
# `investigation` value isn't supported at this time.
|
1396
1403
|
# @return [String]
|
1397
1404
|
#
|
1398
1405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventType AWS API Documentation
|
@@ -1426,13 +1433,14 @@ module Aws::Health
|
|
1426
1433
|
# @return [Array<String>]
|
1427
1434
|
#
|
1428
1435
|
# @!attribute [rw] services
|
1429
|
-
# The
|
1430
|
-
# `RDS`.
|
1436
|
+
# The Amazon Web Services services associated with the event. For
|
1437
|
+
# example, `EC2`, `RDS`.
|
1431
1438
|
# @return [Array<String>]
|
1432
1439
|
#
|
1433
1440
|
# @!attribute [rw] event_type_categories
|
1434
|
-
# A list of event type category codes
|
1435
|
-
# `accountNotification`
|
1441
|
+
# A list of event type category codes. Possible values are `issue`,
|
1442
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1443
|
+
# `investigation` value isn't supported at this time.
|
1436
1444
|
# @return [Array<String>]
|
1437
1445
|
#
|
1438
1446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventTypeFilter AWS API Documentation
|
@@ -1467,8 +1475,8 @@ module Aws::Health
|
|
1467
1475
|
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
1468
1476
|
#
|
1469
1477
|
# @!attribute [rw] aws_account_id
|
1470
|
-
# The 12-digit
|
1471
|
-
# entities.
|
1478
|
+
# The 12-digit Amazon Web Services account numbers that contains the
|
1479
|
+
# affected entities.
|
1472
1480
|
# @return [String]
|
1473
1481
|
#
|
1474
1482
|
# @!attribute [rw] event_arn
|
@@ -1520,7 +1528,8 @@ module Aws::Health
|
|
1520
1528
|
# @return [String]
|
1521
1529
|
#
|
1522
1530
|
# @!attribute [rw] service
|
1523
|
-
# The
|
1531
|
+
# The Amazon Web Services service that is affected by the event, such
|
1532
|
+
# as EC2 and RDS.
|
1524
1533
|
# @return [String]
|
1525
1534
|
#
|
1526
1535
|
# @!attribute [rw] event_type_code
|
@@ -1530,28 +1539,31 @@ module Aws::Health
|
|
1530
1539
|
# @return [String]
|
1531
1540
|
#
|
1532
1541
|
# @!attribute [rw] event_type_category
|
1533
|
-
#
|
1542
|
+
# A list of event type category codes. Possible values are `issue`,
|
1543
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1544
|
+
# `investigation` value isn't supported at this time.
|
1534
1545
|
# @return [String]
|
1535
1546
|
#
|
1536
1547
|
# @!attribute [rw] event_scope_code
|
1537
|
-
# This parameter specifies if the
|
1538
|
-
# service event or an account-specific event.
|
1548
|
+
# This parameter specifies if the Health event is a public Amazon Web
|
1549
|
+
# Services service event or an account-specific event.
|
1539
1550
|
#
|
1540
1551
|
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
1541
1552
|
# `affectedAccounts` value is always empty.
|
1542
1553
|
#
|
1543
1554
|
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
1544
|
-
# `affectedAccounts` value lists the affected
|
1545
|
-
# organization. For example, if an event affects a
|
1546
|
-
# Amazon Elastic Compute Cloud and you have
|
1547
|
-
# that service, those account IDs
|
1555
|
+
# `affectedAccounts` value lists the affected Amazon Web Services
|
1556
|
+
# accounts in your organization. For example, if an event affects a
|
1557
|
+
# service such as Amazon Elastic Compute Cloud and you have Amazon
|
1558
|
+
# Web Services accounts that use that service, those account IDs
|
1559
|
+
# appear in the response.
|
1548
1560
|
#
|
1549
1561
|
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
1550
1562
|
# you specified in the request is invalid or doesn't exist.
|
1551
1563
|
# @return [String]
|
1552
1564
|
#
|
1553
1565
|
# @!attribute [rw] region
|
1554
|
-
# The
|
1566
|
+
# The Amazon Web Services Region name of the event.
|
1555
1567
|
# @return [String]
|
1556
1568
|
#
|
1557
1569
|
# @!attribute [rw] start_time
|
@@ -1600,25 +1612,26 @@ module Aws::Health
|
|
1600
1612
|
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1601
1613
|
#
|
1602
1614
|
# @!attribute [rw] aws_account_id
|
1603
|
-
# The 12-digit
|
1604
|
-
# entities.
|
1615
|
+
# The 12-digit Amazon Web Services account numbers that contains the
|
1616
|
+
# affected entities.
|
1605
1617
|
# @return [String]
|
1606
1618
|
#
|
1607
1619
|
# @!attribute [rw] event
|
1608
|
-
# Summary information about an
|
1620
|
+
# Summary information about an Health event.
|
1609
1621
|
#
|
1610
|
-
#
|
1622
|
+
# Health events can be public or account-specific:
|
1611
1623
|
#
|
1612
1624
|
# * *Public events* might be service events that are not specific to
|
1613
|
-
# an
|
1614
|
-
# Region,
|
1615
|
-
# you don't use services or resources in
|
1625
|
+
# an Amazon Web Services account. For example, if there is an issue
|
1626
|
+
# with an Amazon Web Services Region, Health provides information
|
1627
|
+
# about the event, even if you don't use services or resources in
|
1628
|
+
# that Region.
|
1616
1629
|
#
|
1617
|
-
# * *Account-specific* events are specific to either your
|
1618
|
-
# or an account in your organization. For example,
|
1619
|
-
# issue with Amazon Elastic Compute Cloud in a Region
|
1620
|
-
#
|
1621
|
-
# resources in the account.
|
1630
|
+
# * *Account-specific* events are specific to either your Amazon Web
|
1631
|
+
# Services account or an account in your organization. For example,
|
1632
|
+
# if there's an issue with Amazon Elastic Compute Cloud in a Region
|
1633
|
+
# that you use, Health provides information about the event and the
|
1634
|
+
# affected resources in the account.
|
1622
1635
|
#
|
1623
1636
|
# You can determine if an event is public or account-specific by using
|
1624
1637
|
# the `eventScopeCode` parameter. For more information, see
|
@@ -1693,16 +1706,18 @@ module Aws::Health
|
|
1693
1706
|
# the message:
|
1694
1707
|
#
|
1695
1708
|
# * We couldn't find a public event that matches your request. To
|
1696
|
-
# find an event that is account specific, you must enter an
|
1697
|
-
# account ID in the request.
|
1709
|
+
# find an event that is account specific, you must enter an Amazon
|
1710
|
+
# Web Services account ID in the request.
|
1698
1711
|
#
|
1699
|
-
# * We couldn't find an account specific event for the specified
|
1700
|
-
# account. To find an event that is public, you
|
1701
|
-
# value for the
|
1712
|
+
# * We couldn't find an account specific event for the specified
|
1713
|
+
# Amazon Web Services account. To find an event that is public, you
|
1714
|
+
# must enter a null value for the Amazon Web Services account ID in
|
1715
|
+
# the request.
|
1702
1716
|
#
|
1703
|
-
# * Your
|
1704
|
-
# use the
|
1705
|
-
# Enterprise Support
|
1717
|
+
# * Your Amazon Web Services account doesn't include the Amazon Web
|
1718
|
+
# Services Support plan required to use the Health API. You must
|
1719
|
+
# have either a Business, Enterprise On-Ramp, or Enterprise Support
|
1720
|
+
# plan.
|
1706
1721
|
# @return [String]
|
1707
1722
|
#
|
1708
1723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetailsErrorItem AWS API Documentation
|
@@ -1755,17 +1770,17 @@ module Aws::Health
|
|
1755
1770
|
# @return [Array<String>]
|
1756
1771
|
#
|
1757
1772
|
# @!attribute [rw] aws_account_ids
|
1758
|
-
# A list of 12-digit
|
1759
|
-
# entities.
|
1773
|
+
# A list of 12-digit Amazon Web Services account numbers that contains
|
1774
|
+
# the affected entities.
|
1760
1775
|
# @return [Array<String>]
|
1761
1776
|
#
|
1762
1777
|
# @!attribute [rw] services
|
1763
|
-
# The
|
1764
|
-
# `RDS`.
|
1778
|
+
# The Amazon Web Services services associated with the event. For
|
1779
|
+
# example, `EC2`, `RDS`.
|
1765
1780
|
# @return [Array<String>]
|
1766
1781
|
#
|
1767
1782
|
# @!attribute [rw] regions
|
1768
|
-
# A list of
|
1783
|
+
# A list of Amazon Web Services Regions.
|
1769
1784
|
# @return [Array<String>]
|
1770
1785
|
#
|
1771
1786
|
# @!attribute [rw] start_time
|
@@ -1823,8 +1838,9 @@ module Aws::Health
|
|
1823
1838
|
# @return [Array<String>]
|
1824
1839
|
#
|
1825
1840
|
# @!attribute [rw] event_type_categories
|
1826
|
-
# A list of event type category codes
|
1827
|
-
# accountNotification
|
1841
|
+
# A list of event type category codes. Possible values are `issue`,
|
1842
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1843
|
+
# `investigation` value isn't supported at this time.
|
1828
1844
|
# @return [Array<String>]
|
1829
1845
|
#
|
1830
1846
|
# @!attribute [rw] event_status_codes
|
data/lib/aws-sdk-health.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-health
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.45.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-12-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.125.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.125.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|