aws-sdk-health 1.41.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-health/client.rb +91 -90
- data/lib/aws-sdk-health/types.rb +108 -93
- data/lib/aws-sdk-health.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 96685e1e30a1168fa5cb1d86068f3ee9f289ab782a7369893458fcf0e14a628c
|
4
|
+
data.tar.gz: 649db2c45ce45110ac1a1318ab3a15e43256623464a1093dc932bfb1e1ff0e6e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 39bf2efb423c06f199636ebe9b6bd0627d642a48469becc8685b15542326b9563c7aaed9188744646dd4797deb3d19aec5556a0448857a8e2870d79ad9b3e259
|
7
|
+
data.tar.gz: 84b55e5a702a86a1476ebb6ad1d5715fa6536378afcfec2ad49bcf98e682ed03e49a22110e3397f523d497d33fce439b0f1fe48e36b78a937a0548e55a72e70f
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
@@ -346,12 +346,12 @@ module Aws::Health
|
|
346
346
|
|
347
347
|
# @!group API Operations
|
348
348
|
|
349
|
-
# Returns a list of accounts in the organization from
|
350
|
-
#
|
351
|
-
#
|
349
|
+
# Returns a list of accounts in the organization from Organizations that
|
350
|
+
# are affected by the provided event. For more information about the
|
351
|
+
# different types of Health events, see [Event][1].
|
352
352
|
#
|
353
|
-
# Before you can call this operation, you must first enable
|
354
|
-
#
|
353
|
+
# Before you can call this operation, you must first enable Health to
|
354
|
+
# work with Organizations. To do this, call the
|
355
355
|
# [EnableHealthServiceAccessForOrganization][2] operation from your
|
356
356
|
# organization's management account.
|
357
357
|
#
|
@@ -420,20 +420,20 @@ module Aws::Health
|
|
420
420
|
# Returns a list of entities that have been affected by the specified
|
421
421
|
# events, based on the specified filter criteria. Entities can refer to
|
422
422
|
# 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
|
423
|
+
# other construct, depending on the Amazon Web Services service. Events
|
424
|
+
# that have impact beyond that of the affected entities, or where the
|
425
|
+
# extent of impact is unknown, include at least one entity indicating
|
426
|
+
# this.
|
426
427
|
#
|
427
|
-
# At least one event ARN is required.
|
428
|
-
# `lastUpdatedTime` of the entity, starting with the most recent.
|
428
|
+
# At least one event ARN is required.
|
429
429
|
#
|
430
430
|
# <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
|
431
431
|
# parameter in the next request to return more results.
|
432
432
|
#
|
433
433
|
# * This operation supports resource-level permissions. You can use this
|
434
|
-
# operation to allow or deny access to specific
|
434
|
+
# operation to allow or deny access to specific Health events. For
|
435
435
|
# more information, see [Resource- and action-based conditions][1] in
|
436
|
-
# the *
|
436
|
+
# the *Health User Guide*.
|
437
437
|
#
|
438
438
|
# </note>
|
439
439
|
#
|
@@ -516,17 +516,16 @@ module Aws::Health
|
|
516
516
|
end
|
517
517
|
|
518
518
|
# 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
|
-
#
|
519
|
+
# events for one or more accounts in your organization in Organizations,
|
520
|
+
# based on the filter criteria. Entities can refer to individual
|
521
|
+
# customer resources, groups of customer resources, or any other
|
522
|
+
# construct, depending on the Amazon Web Services service.
|
523
523
|
#
|
524
524
|
# At least one event Amazon Resource Name (ARN) and account ID are
|
525
|
-
# required.
|
526
|
-
# starting with the most recent.
|
525
|
+
# required.
|
527
526
|
#
|
528
|
-
# Before you can call this operation, you must first enable
|
529
|
-
#
|
527
|
+
# Before you can call this operation, you must first enable Health to
|
528
|
+
# work with Organizations. To do this, call the
|
530
529
|
# [EnableHealthServiceAccessForOrganization][1] operation from your
|
531
530
|
# organization's management account.
|
532
531
|
#
|
@@ -534,9 +533,9 @@ module Aws::Health
|
|
534
533
|
# parameter in the next request to return more results.
|
535
534
|
#
|
536
535
|
# * 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 *
|
536
|
+
# can't use this operation to allow or deny access to specific Health
|
537
|
+
# events. For more information, see [Resource- and action-based
|
538
|
+
# conditions][2] in the *Health User Guide*.
|
540
539
|
#
|
541
540
|
# </note>
|
542
541
|
#
|
@@ -615,8 +614,7 @@ module Aws::Health
|
|
615
614
|
end
|
616
615
|
|
617
616
|
# Returns the number of entities that are affected by each of the
|
618
|
-
# specified events.
|
619
|
-
# affected entities are returned.
|
617
|
+
# specified events.
|
620
618
|
#
|
621
619
|
# @option params [Array<String>] :event_arns
|
622
620
|
# A list of event ARNs (unique identifiers). For example:
|
@@ -740,19 +738,20 @@ module Aws::Health
|
|
740
738
|
end
|
741
739
|
|
742
740
|
# 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]
|
741
|
+
# Information includes standard event data (Amazon Web Services Region,
|
742
|
+
# service, and so on, as returned by [DescribeEvents][1]), a detailed
|
743
|
+
# event description, and possible additional metadata that depends upon
|
744
|
+
# the nature of the event. Affected entities are not included. To
|
745
|
+
# retrieve the entities, use the [DescribeAffectedEntities][2]
|
746
|
+
# operation.
|
748
747
|
#
|
749
748
|
# If a specified event can't be retrieved, an error message is returned
|
750
749
|
# for that event.
|
751
750
|
#
|
752
751
|
# <note markdown="1"> This operation supports resource-level permissions. You can use this
|
753
|
-
# operation to allow or deny access to specific
|
754
|
-
#
|
755
|
-
#
|
752
|
+
# operation to allow or deny access to specific Health events. For more
|
753
|
+
# information, see [Resource- and action-based conditions][3] in the
|
754
|
+
# *Health User Guide*.
|
756
755
|
#
|
757
756
|
# </note>
|
758
757
|
#
|
@@ -815,15 +814,16 @@ module Aws::Health
|
|
815
814
|
end
|
816
815
|
|
817
816
|
# 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
|
817
|
+
# one or more Amazon Web Services accounts in your organization. This
|
818
|
+
# information includes standard event data (such as the Amazon Web
|
819
|
+
# Services Region and service), an event description, and (depending on
|
820
|
+
# the event) possible metadata. This operation doesn't return affected
|
821
|
+
# entities, such as the resources related to the event. To return
|
822
|
+
# affected entities, use the
|
823
823
|
# [DescribeAffectedEntitiesForOrganization][1] operation.
|
824
824
|
#
|
825
|
-
# <note markdown="1"> Before you can call this operation, you must first enable
|
826
|
-
#
|
825
|
+
# <note markdown="1"> Before you can call this operation, you must first enable Health to
|
826
|
+
# work with Organizations. To do this, call the
|
827
827
|
# [EnableHealthServiceAccessForOrganization][2] operation from your
|
828
828
|
# organization's management account.
|
829
829
|
#
|
@@ -831,26 +831,25 @@ module Aws::Health
|
|
831
831
|
#
|
832
832
|
# When you call the `DescribeEventDetailsForOrganization` operation,
|
833
833
|
# specify the `organizationEventDetailFilters` object in the request.
|
834
|
-
# Depending on the
|
835
|
-
# differences:
|
834
|
+
# Depending on the Health event type, note the following differences:
|
836
835
|
#
|
837
836
|
# * To return event details for a public event, you must specify a null
|
838
837
|
# value for the `awsAccountId` parameter. If you specify an account ID
|
839
|
-
# for a public event,
|
840
|
-
#
|
838
|
+
# for a public event, Health returns an error message because public
|
839
|
+
# events aren't specific to an account.
|
841
840
|
#
|
842
841
|
# * To return event details for an event that is specific to an account
|
843
842
|
# in your organization, you must specify the `awsAccountId` parameter
|
844
|
-
# in the request. If you don't specify an account ID,
|
845
|
-
#
|
846
|
-
#
|
843
|
+
# in the request. If you don't specify an account ID, Health returns
|
844
|
+
# an error message because the event is specific to an account in your
|
845
|
+
# organization.
|
847
846
|
#
|
848
847
|
# For more information, see [Event][3].
|
849
848
|
#
|
850
849
|
# <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
|
-
#
|
850
|
+
# use this operation to allow or deny access to specific Health events.
|
851
|
+
# For more information, see [Resource- and action-based conditions][4]
|
852
|
+
# in the *Health User Guide*.
|
854
853
|
#
|
855
854
|
# </note>
|
856
855
|
#
|
@@ -920,9 +919,9 @@ module Aws::Health
|
|
920
919
|
end
|
921
920
|
|
922
921
|
# 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.
|
922
|
+
# can use this API operation to find information about the Health event,
|
923
|
+
# such as the category, Amazon Web Services service, and event code. The
|
924
|
+
# metadata for each event appears in the [EventType][1] object.
|
926
925
|
#
|
927
926
|
# If you don't specify a filter criteria, the API operation returns all
|
928
927
|
# event types, in no particular order.
|
@@ -1002,13 +1001,13 @@ module Aws::Health
|
|
1002
1001
|
# are sorted by `lastModifiedTime`, starting with the most recent event.
|
1003
1002
|
#
|
1004
1003
|
# <note markdown="1"> * When you call the `DescribeEvents` operation and specify an entity
|
1005
|
-
# for the `entityValues` parameter,
|
1006
|
-
#
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
1010
|
-
#
|
1011
|
-
#
|
1004
|
+
# for the `entityValues` parameter, Health might return public events
|
1005
|
+
# that aren't specific to that resource. For example, if you call
|
1006
|
+
# `DescribeEvents` and specify an ID for an Amazon Elastic Compute
|
1007
|
+
# Cloud (Amazon EC2) instance, Health might return events that aren't
|
1008
|
+
# specific to that resource or service. To get events that are
|
1009
|
+
# specific to a service, use the `services` parameter in the `filter`
|
1010
|
+
# object. For more information, see [Event][3].
|
1012
1011
|
#
|
1013
1012
|
# * This API operation uses pagination. Specify the `nextToken`
|
1014
1013
|
# parameter in the next request to return more results.
|
@@ -1113,7 +1112,7 @@ module Aws::Health
|
|
1113
1112
|
req.send_request(options)
|
1114
1113
|
end
|
1115
1114
|
|
1116
|
-
# Returns information about events across your organization in
|
1115
|
+
# Returns information about events across your organization in
|
1117
1116
|
# Organizations. You can use the`filters` parameter to specify the
|
1118
1117
|
# events that you want to return. Events are returned in a summary form
|
1119
1118
|
# and don't include the affected accounts, detailed description, any
|
@@ -1130,11 +1129,11 @@ module Aws::Health
|
|
1130
1129
|
# returns all events across your organization. Results are sorted by
|
1131
1130
|
# `lastModifiedTime`, starting with the most recent event.
|
1132
1131
|
#
|
1133
|
-
# For more information about the different types of
|
1134
|
-
#
|
1132
|
+
# For more information about the different types of Health events, see
|
1133
|
+
# [Event][4].
|
1135
1134
|
#
|
1136
|
-
# Before you can call this operation, you must first enable
|
1137
|
-
#
|
1135
|
+
# Before you can call this operation, you must first enable Health to
|
1136
|
+
# work with Organizations. To do this, call the
|
1138
1137
|
# [EnableHealthServiceAccessForOrganization][5] operation from your
|
1139
1138
|
# organization's management account.
|
1140
1139
|
#
|
@@ -1231,7 +1230,7 @@ module Aws::Health
|
|
1231
1230
|
end
|
1232
1231
|
|
1233
1232
|
# This operation provides status information on enabling or disabling
|
1234
|
-
#
|
1233
|
+
# Health to work with your organization. To call this operation, you
|
1235
1234
|
# must sign in as an IAM user, assume an IAM role, or sign in as the
|
1236
1235
|
# root user (not recommended) in the organization's management account.
|
1237
1236
|
#
|
@@ -1252,25 +1251,26 @@ module Aws::Health
|
|
1252
1251
|
req.send_request(options)
|
1253
1252
|
end
|
1254
1253
|
|
1255
|
-
# Disables
|
1256
|
-
# operation, you must sign in as an
|
1257
|
-
#
|
1254
|
+
# Disables Health from working with Organizations. To call this
|
1255
|
+
# operation, you must sign in as an Identity and Access Management (IAM)
|
1256
|
+
# user, assume an IAM role, or sign in as the root user (not
|
1258
1257
|
# recommended) in the organization's management account. For more
|
1259
|
-
# information, see [Aggregating
|
1260
|
-
#
|
1258
|
+
# information, see [Aggregating Health events][1] in the *Health User
|
1259
|
+
# Guide*.
|
1261
1260
|
#
|
1262
1261
|
# This operation doesn't remove the service-linked role from the
|
1263
1262
|
# management account in your organization. You must use the IAM console,
|
1264
|
-
# API, or
|
1265
|
-
#
|
1266
|
-
#
|
1263
|
+
# API, or Command Line Interface (CLI) to remove the service-linked
|
1264
|
+
# role. For more information, see [Deleting a Service-Linked Role][2] in
|
1265
|
+
# the *IAM User Guide*.
|
1267
1266
|
#
|
1268
1267
|
# <note markdown="1"> You can also disable the organizational feature by using the
|
1269
1268
|
# 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
|
1269
|
+
# call this operation, Health stops aggregating events for all other
|
1270
|
+
# Amazon Web Services accounts in your organization. If you call the
|
1271
|
+
# Health API operations for organizational view, Health returns an
|
1272
|
+
# error. Health continues to aggregate health events for your Amazon Web
|
1273
|
+
# Services account.
|
1274
1274
|
#
|
1275
1275
|
# </note>
|
1276
1276
|
#
|
@@ -1291,30 +1291,31 @@ module Aws::Health
|
|
1291
1291
|
req.send_request(options)
|
1292
1292
|
end
|
1293
1293
|
|
1294
|
-
# Enables
|
1295
|
-
# organizational view feature to aggregate events from all
|
1296
|
-
# in your organization in a centralized location.
|
1294
|
+
# Enables Health to work with Organizations. You can use the
|
1295
|
+
# organizational view feature to aggregate events from all Amazon Web
|
1296
|
+
# Services accounts in your organization in a centralized location.
|
1297
1297
|
#
|
1298
1298
|
# This operation also creates a service-linked role for the management
|
1299
1299
|
# account in the organization.
|
1300
1300
|
#
|
1301
1301
|
# <note markdown="1"> To call this operation, you must meet the following requirements:
|
1302
1302
|
#
|
1303
|
-
# * You must have a Business or Enterprise Support plan from [
|
1304
|
-
# Support][1] to use the
|
1305
|
-
# API from an
|
1306
|
-
# Support plan, you receive a
|
1303
|
+
# * You must have a Business or Enterprise Support plan from [Amazon Web
|
1304
|
+
# Services Support][1] to use the Health API. If you call the Health
|
1305
|
+
# API from an Amazon Web Services account that doesn't have a
|
1306
|
+
# Business or Enterprise Support plan, you receive a
|
1307
|
+
# `SubscriptionRequiredException` error.
|
1307
1308
|
#
|
1308
1309
|
# * You must have permission to call this operation from the
|
1309
1310
|
# organization's management account. For example IAM policies, see
|
1310
|
-
# [
|
1311
|
+
# [Health identity-based policy examples][2].
|
1311
1312
|
#
|
1312
1313
|
# </note>
|
1313
1314
|
#
|
1314
1315
|
# If you don't have the required support plan, you can instead use the
|
1315
|
-
#
|
1316
|
-
# information, see [Aggregating
|
1317
|
-
#
|
1316
|
+
# Health console to enable the organizational view feature. For more
|
1317
|
+
# information, see [Aggregating Health events][3] in the *Health User
|
1318
|
+
# Guide*.
|
1318
1319
|
#
|
1319
1320
|
#
|
1320
1321
|
#
|
@@ -1346,7 +1347,7 @@ module Aws::Health
|
|
1346
1347
|
params: params,
|
1347
1348
|
config: config)
|
1348
1349
|
context[:gem_name] = 'aws-sdk-health'
|
1349
|
-
context[:gem_version] = '1.
|
1350
|
+
context[:gem_version] = '1.42.0'
|
1350
1351
|
Seahorse::Client::Request.new(handlers, context)
|
1351
1352
|
end
|
1352
1353
|
|
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,17 @@ 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 plan.
|
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 or Enterprise Support plan.
|
1706
1720
|
# @return [String]
|
1707
1721
|
#
|
1708
1722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetailsErrorItem AWS API Documentation
|
@@ -1755,17 +1769,17 @@ module Aws::Health
|
|
1755
1769
|
# @return [Array<String>]
|
1756
1770
|
#
|
1757
1771
|
# @!attribute [rw] aws_account_ids
|
1758
|
-
# A list of 12-digit
|
1759
|
-
# entities.
|
1772
|
+
# A list of 12-digit Amazon Web Services account numbers that contains
|
1773
|
+
# the affected entities.
|
1760
1774
|
# @return [Array<String>]
|
1761
1775
|
#
|
1762
1776
|
# @!attribute [rw] services
|
1763
|
-
# The
|
1764
|
-
# `RDS`.
|
1777
|
+
# The Amazon Web Services services associated with the event. For
|
1778
|
+
# example, `EC2`, `RDS`.
|
1765
1779
|
# @return [Array<String>]
|
1766
1780
|
#
|
1767
1781
|
# @!attribute [rw] regions
|
1768
|
-
# A list of
|
1782
|
+
# A list of Amazon Web Services Regions.
|
1769
1783
|
# @return [Array<String>]
|
1770
1784
|
#
|
1771
1785
|
# @!attribute [rw] start_time
|
@@ -1823,8 +1837,9 @@ module Aws::Health
|
|
1823
1837
|
# @return [Array<String>]
|
1824
1838
|
#
|
1825
1839
|
# @!attribute [rw] event_type_categories
|
1826
|
-
# A list of event type category codes
|
1827
|
-
# accountNotification
|
1840
|
+
# A list of event type category codes. Possible values are `issue`,
|
1841
|
+
# `accountNotification`, or `scheduledChange`. Currently, the
|
1842
|
+
# `investigation` value isn't supported at this time.
|
1828
1843
|
# @return [Array<String>]
|
1829
1844
|
#
|
1830
1845
|
# @!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.42.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-
|
11
|
+
date: 2021-11-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|