aws-sdk-health 1.40.0 → 1.44.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
2
  SHA256:
3
- metadata.gz: 8f1055b7fcfeb4cea78686d0c5b3967a89321cd9217900a9f82ac8d4f2c86b15
4
- data.tar.gz: dbe0b1c1089cb90e53125c3afea1b0bae270ba5f55a92e235f3d8693f2e19a07
3
+ metadata.gz: a4eb6b6b46461d5ddc7d5bf63802b3a90b382eb255530077f4bed7ceef4e71ef
4
+ data.tar.gz: c016ef8262f0d90171e8dc75014d1241efc412f51d256797a8beeeb577a1d941
5
5
  SHA512:
6
- metadata.gz: 15250a66dda2ce2489694a66a62dde55bc9a0377034985a8325aafae3638425e8132c771430d079eb4c5331cbf0562db2ba37857ad8e6a7cb8f893a347986a95
7
- data.tar.gz: d817c15508731fb53e8b92c6a6e5b065928817f869d9bffca9a516b60a6e951d9f6ce48696c35e363d2875d6a9156ba1b87d08b67e028166bc4cb431798ea82e
6
+ metadata.gz: f23ff6716a38858d835cb79687c6be61230fece3cf2a4037c29fe0518b6108002787485a6e9a4cdf58da4a3f799b4d3a729501773db31224f181f38ea6972ab6
7
+ data.tar.gz: 40e74ad305c992aec2087c01c484faf6c22693e80612617387c01b7ddd9abc09be124cb851534908a9cb2fd6d3adc5cd2cf34d2d9a122c8903e7fdb177867090
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.44.0 (2021-12-08)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for AWS Health
8
+
9
+ 1.43.0 (2021-11-30)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.42.0 (2021-11-09)
15
+ ------------------
16
+
17
+ * Feature - Documentation updates for AWS Health.
18
+
19
+ 1.41.0 (2021-11-04)
20
+ ------------------
21
+
22
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
23
+
4
24
  1.40.0 (2021-10-18)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.40.0
1
+ 1.44.0
@@ -119,7 +119,9 @@ module Aws::Health
119
119
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
120
  # are very aggressive. Construct and pass an instance of
121
121
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
123
125
  #
124
126
  # @option options [required, String] :region
125
127
  # The AWS region to connect to. The configured `:region` is
@@ -285,6 +287,15 @@ module Aws::Health
285
287
  # ** Please note ** When response stubbing is enabled, no HTTP
286
288
  # requests are made, and retries are disabled.
287
289
  #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
288
299
  # @option options [Boolean] :validate_params (true)
289
300
  # When `true`, request parameters are validated before
290
301
  # sending the request.
@@ -337,12 +348,12 @@ module Aws::Health
337
348
 
338
349
  # @!group API Operations
339
350
 
340
- # Returns a list of accounts in the organization from AWS Organizations
341
- # that are affected by the provided event. For more information about
342
- # the different types of AWS Health events, see [Event][1].
351
+ # Returns a list of accounts in the organization from Organizations that
352
+ # are affected by the provided event. For more information about the
353
+ # different types of Health events, see [Event][1].
343
354
  #
344
- # Before you can call this operation, you must first enable AWS Health
345
- # to work with AWS Organizations. To do this, call the
355
+ # Before you can call this operation, you must first enable Health to
356
+ # work with Organizations. To do this, call the
346
357
  # [EnableHealthServiceAccessForOrganization][2] operation from your
347
358
  # organization's management account.
348
359
  #
@@ -411,20 +422,20 @@ module Aws::Health
411
422
  # Returns a list of entities that have been affected by the specified
412
423
  # events, based on the specified filter criteria. Entities can refer to
413
424
  # individual customer resources, groups of customer resources, or any
414
- # other construct, depending on the AWS service. Events that have impact
415
- # beyond that of the affected entities, or where the extent of impact is
416
- # unknown, include at least one entity indicating this.
425
+ # other construct, depending on the Amazon Web Services service. Events
426
+ # that have impact beyond that of the affected entities, or where the
427
+ # extent of impact is unknown, include at least one entity indicating
428
+ # this.
417
429
  #
418
- # At least one event ARN is required. Results are sorted by the
419
- # `lastUpdatedTime` of the entity, starting with the most recent.
430
+ # At least one event ARN is required.
420
431
  #
421
432
  # <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
422
433
  # parameter in the next request to return more results.
423
434
  #
424
435
  # * This operation supports resource-level permissions. You can use this
425
- # operation to allow or deny access to specific AWS Health events. For
436
+ # operation to allow or deny access to specific Health events. For
426
437
  # more information, see [Resource- and action-based conditions][1] in
427
- # the *AWS Health User Guide*.
438
+ # the *Health User Guide*.
428
439
  #
429
440
  # </note>
430
441
  #
@@ -507,17 +518,16 @@ module Aws::Health
507
518
  end
508
519
 
509
520
  # Returns a list of entities that have been affected by one or more
510
- # events for one or more accounts in your organization in AWS
511
- # Organizations, based on the filter criteria. Entities can refer to
512
- # individual customer resources, groups of customer resources, or any
513
- # other construct, depending on the AWS service.
521
+ # events for one or more accounts in your organization in Organizations,
522
+ # based on the filter criteria. Entities can refer to individual
523
+ # customer resources, groups of customer resources, or any other
524
+ # construct, depending on the Amazon Web Services service.
514
525
  #
515
526
  # At least one event Amazon Resource Name (ARN) and account ID are
516
- # required. Results are sorted by the `lastUpdatedTime` of the entity,
517
- # starting with the most recent.
527
+ # required.
518
528
  #
519
- # Before you can call this operation, you must first enable AWS Health
520
- # to work with AWS Organizations. To do this, call the
529
+ # Before you can call this operation, you must first enable Health to
530
+ # work with Organizations. To do this, call the
521
531
  # [EnableHealthServiceAccessForOrganization][1] operation from your
522
532
  # organization's management account.
523
533
  #
@@ -525,9 +535,9 @@ module Aws::Health
525
535
  # parameter in the next request to return more results.
526
536
  #
527
537
  # * This operation doesn't support resource-level permissions. You
528
- # can't use this operation to allow or deny access to specific AWS
529
- # Health events. For more information, see [Resource- and action-based
530
- # conditions][2] in the *AWS Health User Guide*.
538
+ # can't use this operation to allow or deny access to specific Health
539
+ # events. For more information, see [Resource- and action-based
540
+ # conditions][2] in the *Health User Guide*.
531
541
  #
532
542
  # </note>
533
543
  #
@@ -606,8 +616,7 @@ module Aws::Health
606
616
  end
607
617
 
608
618
  # Returns the number of entities that are affected by each of the
609
- # specified events. If no events are specified, the counts of all
610
- # affected entities are returned.
619
+ # specified events.
611
620
  #
612
621
  # @option params [Array<String>] :event_arns
613
622
  # A list of event ARNs (unique identifiers). For example:
@@ -731,19 +740,20 @@ module Aws::Health
731
740
  end
732
741
 
733
742
  # Returns detailed information about one or more specified events.
734
- # Information includes standard event data (AWS Region, service, and so
735
- # on, as returned by [DescribeEvents][1]), a detailed event description,
736
- # and possible additional metadata that depends upon the nature of the
737
- # event. Affected entities are not included. To retrieve the entities,
738
- # use the [DescribeAffectedEntities][2] operation.
743
+ # Information includes standard event data (Amazon Web Services Region,
744
+ # service, and so on, as returned by [DescribeEvents][1]), a detailed
745
+ # event description, and possible additional metadata that depends upon
746
+ # the nature of the event. Affected entities are not included. To
747
+ # retrieve the entities, use the [DescribeAffectedEntities][2]
748
+ # operation.
739
749
  #
740
750
  # If a specified event can't be retrieved, an error message is returned
741
751
  # for that event.
742
752
  #
743
753
  # <note markdown="1"> This operation supports resource-level permissions. You can use this
744
- # operation to allow or deny access to specific AWS Health events. For
745
- # more information, see [Resource- and action-based conditions][3] in
746
- # the *AWS Health User Guide*.
754
+ # operation to allow or deny access to specific Health events. For more
755
+ # information, see [Resource- and action-based conditions][3] in the
756
+ # *Health User Guide*.
747
757
  #
748
758
  # </note>
749
759
  #
@@ -806,15 +816,16 @@ module Aws::Health
806
816
  end
807
817
 
808
818
  # Returns detailed information about one or more specified events for
809
- # one or more AWS accounts in your organization. This information
810
- # includes standard event data (such as the AWS Region and service), an
811
- # event description, and (depending on the event) possible metadata.
812
- # This operation doesn't return affected entities, such as the
813
- # resources related to the event. To return affected entities, use the
819
+ # one or more Amazon Web Services accounts in your organization. This
820
+ # information includes standard event data (such as the Amazon Web
821
+ # Services Region and service), an event description, and (depending on
822
+ # the event) possible metadata. This operation doesn't return affected
823
+ # entities, such as the resources related to the event. To return
824
+ # affected entities, use the
814
825
  # [DescribeAffectedEntitiesForOrganization][1] operation.
815
826
  #
816
- # <note markdown="1"> Before you can call this operation, you must first enable AWS Health
817
- # to work with AWS Organizations. To do this, call the
827
+ # <note markdown="1"> Before you can call this operation, you must first enable Health to
828
+ # work with Organizations. To do this, call the
818
829
  # [EnableHealthServiceAccessForOrganization][2] operation from your
819
830
  # organization's management account.
820
831
  #
@@ -822,26 +833,25 @@ module Aws::Health
822
833
  #
823
834
  # When you call the `DescribeEventDetailsForOrganization` operation,
824
835
  # specify the `organizationEventDetailFilters` object in the request.
825
- # Depending on the AWS Health event type, note the following
826
- # differences:
836
+ # Depending on the Health event type, note the following differences:
827
837
  #
828
838
  # * To return event details for a public event, you must specify a null
829
839
  # value for the `awsAccountId` parameter. If you specify an account ID
830
- # for a public event, AWS Health returns an error message because
831
- # public events aren't specific to an account.
840
+ # for a public event, Health returns an error message because public
841
+ # events aren't specific to an account.
832
842
  #
833
843
  # * To return event details for an event that is specific to an account
834
844
  # in your organization, you must specify the `awsAccountId` parameter
835
- # in the request. If you don't specify an account ID, AWS Health
836
- # returns an error message because the event is specific to an account
837
- # in your organization.
845
+ # in the request. If you don't specify an account ID, Health returns
846
+ # an error message because the event is specific to an account in your
847
+ # organization.
838
848
  #
839
849
  # For more information, see [Event][3].
840
850
  #
841
851
  # <note markdown="1"> This operation doesn't support resource-level permissions. You can't
842
- # use this operation to allow or deny access to specific AWS Health
843
- # events. For more information, see [Resource- and action-based
844
- # conditions][4] in the *AWS Health User Guide*.
852
+ # use this operation to allow or deny access to specific Health events.
853
+ # For more information, see [Resource- and action-based conditions][4]
854
+ # in the *Health User Guide*.
845
855
  #
846
856
  # </note>
847
857
  #
@@ -911,9 +921,9 @@ module Aws::Health
911
921
  end
912
922
 
913
923
  # Returns the event types that meet the specified filter criteria. You
914
- # can use this API operation to find information about the AWS Health
915
- # event, such as the category, AWS service, and event code. The metadata
916
- # for each event appears in the [EventType][1] object.
924
+ # can use this API operation to find information about the Health event,
925
+ # such as the category, Amazon Web Services service, and event code. The
926
+ # metadata for each event appears in the [EventType][1] object.
917
927
  #
918
928
  # If you don't specify a filter criteria, the API operation returns all
919
929
  # event types, in no particular order.
@@ -993,13 +1003,13 @@ module Aws::Health
993
1003
  # are sorted by `lastModifiedTime`, starting with the most recent event.
994
1004
  #
995
1005
  # <note markdown="1"> * When you call the `DescribeEvents` operation and specify an entity
996
- # for the `entityValues` parameter, AWS Health might return public
997
- # events that aren't specific to that resource. For example, if you
998
- # call `DescribeEvents` and specify an ID for an Amazon Elastic
999
- # Compute Cloud (Amazon EC2) instance, AWS Health might return events
1000
- # that aren't specific to that resource or service. To get events
1001
- # that are specific to a service, use the `services` parameter in the
1002
- # `filter` object. For more information, see [Event][3].
1006
+ # for the `entityValues` parameter, Health might return public events
1007
+ # that aren't specific to that resource. For example, if you call
1008
+ # `DescribeEvents` and specify an ID for an Amazon Elastic Compute
1009
+ # Cloud (Amazon EC2) instance, Health might return events that aren't
1010
+ # specific to that resource or service. To get events that are
1011
+ # specific to a service, use the `services` parameter in the `filter`
1012
+ # object. For more information, see [Event][3].
1003
1013
  #
1004
1014
  # * This API operation uses pagination. Specify the `nextToken`
1005
1015
  # parameter in the next request to return more results.
@@ -1104,7 +1114,7 @@ module Aws::Health
1104
1114
  req.send_request(options)
1105
1115
  end
1106
1116
 
1107
- # Returns information about events across your organization in AWS
1117
+ # Returns information about events across your organization in
1108
1118
  # Organizations. You can use the`filters` parameter to specify the
1109
1119
  # events that you want to return. Events are returned in a summary form
1110
1120
  # and don't include the affected accounts, detailed description, any
@@ -1121,11 +1131,11 @@ module Aws::Health
1121
1131
  # returns all events across your organization. Results are sorted by
1122
1132
  # `lastModifiedTime`, starting with the most recent event.
1123
1133
  #
1124
- # For more information about the different types of AWS Health events,
1125
- # see [Event][4].
1134
+ # For more information about the different types of Health events, see
1135
+ # [Event][4].
1126
1136
  #
1127
- # Before you can call this operation, you must first enable AWS Health
1128
- # to work with AWS Organizations. To do this, call the
1137
+ # Before you can call this operation, you must first enable Health to
1138
+ # work with Organizations. To do this, call the
1129
1139
  # [EnableHealthServiceAccessForOrganization][5] operation from your
1130
1140
  # organization's management account.
1131
1141
  #
@@ -1222,7 +1232,7 @@ module Aws::Health
1222
1232
  end
1223
1233
 
1224
1234
  # This operation provides status information on enabling or disabling
1225
- # AWS Health to work with your organization. To call this operation, you
1235
+ # Health to work with your organization. To call this operation, you
1226
1236
  # must sign in as an IAM user, assume an IAM role, or sign in as the
1227
1237
  # root user (not recommended) in the organization's management account.
1228
1238
  #
@@ -1243,25 +1253,26 @@ module Aws::Health
1243
1253
  req.send_request(options)
1244
1254
  end
1245
1255
 
1246
- # Disables AWS Health from working with AWS Organizations. To call this
1247
- # operation, you must sign in as an AWS Identity and Access Management
1248
- # (IAM) user, assume an IAM role, or sign in as the root user (not
1256
+ # Disables Health from working with Organizations. To call this
1257
+ # operation, you must sign in as an Identity and Access Management (IAM)
1258
+ # user, assume an IAM role, or sign in as the root user (not
1249
1259
  # recommended) in the organization's management account. For more
1250
- # information, see [Aggregating AWS Health events][1] in the *AWS Health
1251
- # User Guide*.
1260
+ # information, see [Aggregating Health events][1] in the *Health User
1261
+ # Guide*.
1252
1262
  #
1253
1263
  # This operation doesn't remove the service-linked role from the
1254
1264
  # management account in your organization. You must use the IAM console,
1255
- # API, or AWS Command Line Interface (AWS CLI) to remove the
1256
- # service-linked role. For more information, see [Deleting a
1257
- # Service-Linked Role][2] in the *IAM User Guide*.
1265
+ # API, or Command Line Interface (CLI) to remove the service-linked
1266
+ # role. For more information, see [Deleting a Service-Linked Role][2] in
1267
+ # the *IAM User Guide*.
1258
1268
  #
1259
1269
  # <note markdown="1"> You can also disable the organizational feature by using the
1260
1270
  # Organizations [DisableAWSServiceAccess][3] API operation. After you
1261
- # call this operation, AWS Health stops aggregating events for all other
1262
- # AWS accounts in your organization. If you call the AWS Health API
1263
- # operations for organizational view, AWS Health returns an error. AWS
1264
- # Health continues to aggregate health events for your AWS account.
1271
+ # call this operation, Health stops aggregating events for all other
1272
+ # Amazon Web Services accounts in your organization. If you call the
1273
+ # Health API operations for organizational view, Health returns an
1274
+ # error. Health continues to aggregate health events for your Amazon Web
1275
+ # Services account.
1265
1276
  #
1266
1277
  # </note>
1267
1278
  #
@@ -1282,30 +1293,31 @@ module Aws::Health
1282
1293
  req.send_request(options)
1283
1294
  end
1284
1295
 
1285
- # Enables AWS Health to work with AWS Organizations. You can use the
1286
- # organizational view feature to aggregate events from all AWS accounts
1287
- # in your organization in a centralized location.
1296
+ # Enables Health to work with Organizations. You can use the
1297
+ # organizational view feature to aggregate events from all Amazon Web
1298
+ # Services accounts in your organization in a centralized location.
1288
1299
  #
1289
1300
  # This operation also creates a service-linked role for the management
1290
1301
  # account in the organization.
1291
1302
  #
1292
1303
  # <note markdown="1"> To call this operation, you must meet the following requirements:
1293
1304
  #
1294
- # * You must have a Business or Enterprise Support plan from [AWS
1295
- # Support][1] to use the AWS Health API. If you call the AWS Health
1296
- # API from an AWS account that doesn't have a Business or Enterprise
1297
- # Support plan, you receive a `SubscriptionRequiredException` error.
1305
+ # * You must have a Business, Enterprise On-Ramp, or Enterprise Support
1306
+ # plan from [Amazon Web Services Support][1] to use the Health API. If
1307
+ # you call the Health API from an Amazon Web Services account that
1308
+ # doesn't have a Business, Enterprise On-Ramp, or Enterprise Support
1309
+ # plan, you receive a `SubscriptionRequiredException` error.
1298
1310
  #
1299
1311
  # * You must have permission to call this operation from the
1300
1312
  # organization's management account. For example IAM policies, see
1301
- # [AWS Health identity-based policy examples][2].
1313
+ # [Health identity-based policy examples][2].
1302
1314
  #
1303
1315
  # </note>
1304
1316
  #
1305
1317
  # If you don't have the required support plan, you can instead use the
1306
- # AWS Health console to enable the organizational view feature. For more
1307
- # information, see [Aggregating AWS Health events][3] in the *AWS Health
1308
- # User Guide*.
1318
+ # Health console to enable the organizational view feature. For more
1319
+ # information, see [Aggregating Health events][3] in the *Health User
1320
+ # Guide*.
1309
1321
  #
1310
1322
  #
1311
1323
  #
@@ -1337,7 +1349,7 @@ module Aws::Health
1337
1349
  params: params,
1338
1350
  config: config)
1339
1351
  context[:gem_name] = 'aws-sdk-health'
1340
- context[:gem_version] = '1.40.0'
1352
+ context[:gem_version] = '1.44.0'
1341
1353
  Seahorse::Client::Request.new(handlers, context)
1342
1354
  end
1343
1355
 
@@ -38,7 +38,8 @@ module Aws::Health
38
38
  # @return [String]
39
39
  #
40
40
  # @!attribute [rw] aws_account_id
41
- # The 12-digit AWS account number that contains the affected entity.
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 AWS Health event is a public AWS
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 AWS accounts in your
190
- # organization. For example, if an event affects a service such as
191
- # Amazon Elastic Compute Cloud and you have AWS accounts that use
192
- # that service, those account IDs appear in the response.
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 AWS Health
857
- # Organizational View in your organization.
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 [EntityFilter][1]
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/API_EntityFilter.html
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 AWS Health event.
976
+ # Summary information about an Health event.
975
977
  #
976
- # AWS Health events can be public or account-specific:
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
- # AWS account. For example, if there is an issue with an AWS Region,
980
- # AWS Health provides information about the event, even if you don't
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 AWS account or
984
- # an account in your organization. For example, if there's an issue
985
- # with Amazon Elastic Compute Cloud in a Region that you use, AWS
986
- # Health provides information about the event and the affected
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 AWS service that is affected by the event. For example, `EC2`,
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
- # The category of the event. Possible values are `issue`,
1020
- # `scheduledChange`, and `accountNotification`.
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 AWS Region name of the event.
1027
+ # The Amazon Web Services Region name of the event.
1025
1028
  # @return [String]
1026
1029
  #
1027
1030
  # @!attribute [rw] availability_zone
1028
- # The AWS Availability Zone of the event. For example, us-east-1a.
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 AWS Health event is a public AWS
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 AWS accounts in your
1057
- # organization. For example, if an event affects a service such as
1058
- # Amazon Elastic Compute Cloud and you have AWS accounts that use
1059
- # that service, those account IDs appear in the response.
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 AWS account numbers that contains the affected
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 AWS services associated with the event. For example, `EC2`,
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 AWS Regions.
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 AWS Availability Zones.
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 (`issue`, `scheduledChange`, or
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 AWS
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 AWS Health delivers a
1373
- # specific event to your AWS account. For more information, see [Monitor
1374
- # for AWS Health events with Amazon CloudWatch Events][2] in the *AWS
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 AWS service that is affected by the event. For example, `EC2`,
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 (`issue`, `scheduledChange`, or
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 AWS services associated with the event. For example, `EC2`,
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 (`issue`, `scheduledChange`, or
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 AWS account numbers that contains the affected
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 AWS service that is affected by the event, such as EC2 and RDS.
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
- # The category of the event type.
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 AWS Health event is a public AWS
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 AWS accounts in your
1545
- # organization. For example, if an event affects a service such as
1546
- # Amazon Elastic Compute Cloud and you have AWS accounts that use
1547
- # that service, those account IDs appear in the response.
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 AWS Region name of the event.
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 AWS account numbers that contains the affected
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 AWS Health event.
1620
+ # Summary information about an Health event.
1609
1621
  #
1610
- # AWS Health events can be public or account-specific:
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 AWS account. For example, if there is an issue with an AWS
1614
- # Region, AWS Health provides information about the event, even if
1615
- # you don't use services or resources in that Region.
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 AWS account
1618
- # or an account in your organization. For example, if there's an
1619
- # issue with Amazon Elastic Compute Cloud in a Region that you use,
1620
- # AWS Health provides information about the event and the affected
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 AWS
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 AWS
1700
- # account. To find an event that is public, you must enter a null
1701
- # value for the AWS account ID in the request.
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 AWS account doesn't include the AWS Support plan required to
1704
- # use the AWS Health API. You must have either a Business or
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, 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 AWS account numbers that contains the affected
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 AWS services associated with the event. For example, `EC2`,
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 AWS Regions.
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 (issue, scheduledChange, or
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
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-health/customizations'
48
48
  # @!group service
49
49
  module Aws::Health
50
50
 
51
- GEM_VERSION = '1.40.0'
51
+ GEM_VERSION = '1.44.0'
52
52
 
53
53
  end
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.40.0
4
+ version: 1.44.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-10-18 00:00:00.000000000 Z
11
+ date: 2021-12-08 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.121.2
22
+ version: 3.122.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.121.2
32
+ version: 3.122.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement