aws-sdk-health 1.32.0 → 1.33.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: 936fba80fb92d8ef022b98ba518e1bd2ac2f1bb8c7a4f22924c99b85e1e26295
4
- data.tar.gz: 87ae5ca5568f90565a2a8d4bf7b54a38795710c4dee5d5ed47e6dbdf92fbbddd
3
+ metadata.gz: d800aac727d82c251d437f2372c09031fff98e7340a9e4b0cf5beff169a0ce19
4
+ data.tar.gz: c7cc332f1be7aa0e333e02f12a1dcf2b34670a4fe13140820e5e42708abf89e1
5
5
  SHA512:
6
- metadata.gz: 82a36b2d0b876aaeb7771ff2542d8169ed76602ba32b03c832829123f4227bf74073bfaa27ba6f6b33374d1ac933b64f0f79781bc754ae0fe94b6c765da22a2d
7
- data.tar.gz: c7b312a8a835db6ac2c9089ce55be9a7b7f8bf31ab6377014348c2003cd09f562de6a603cfe9dd660ae9fcee7c36162593433bf5c19bdf46a42bc782ce0b2dd5
6
+ metadata.gz: e35ed16d14b06ced5d4268b545ff4379bc5c15e1ce24a0de6eaed28ce940de492f04f765f451dc26f86c235faa589324266894c26c5690fdcfb3f93c3fea8bba
7
+ data.tar.gz: e131e988f3f6c28df37b95c2d97e1f177749066310a8fb751a9e22045a2349532a8f6f38b83160e9ecd7ea7c4a79546bd273877cdad27e546016099cae98db17
@@ -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.32.0'
51
+ GEM_VERSION = '1.33.0'
52
52
 
53
53
  end
@@ -344,7 +344,7 @@ module Aws::Health
344
344
  # Before you can call this operation, you must first enable AWS Health
345
345
  # to work with AWS Organizations. To do this, call the
346
346
  # [EnableHealthServiceAccessForOrganization][2] operation from your
347
- # organization's master account.
347
+ # organization's management account.
348
348
  #
349
349
  # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
350
350
  # in the next request to return more results.
@@ -415,11 +415,20 @@ module Aws::Health
415
415
  # At least one event ARN is required. Results are sorted by the
416
416
  # `lastUpdatedTime` of the entity, starting with the most recent.
417
417
  #
418
- # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
419
- # in the next request to return more results.
418
+ # <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
419
+ # parameter in the next request to return more results.
420
+ #
421
+ # * This operation supports resource-level permissions. You can use this
422
+ # operation to allow or deny access to specific AWS Health events. For
423
+ # more information, see [Resource- and action-based conditions][1] in
424
+ # the *AWS Health User Guide*.
420
425
  #
421
426
  # </note>
422
427
  #
428
+ #
429
+ #
430
+ # [1]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
431
+ #
423
432
  # @option params [required, Types::EntityFilter] :filter
424
433
  # Values to narrow the results returned. At least one event ARN is
425
434
  # required.
@@ -507,16 +516,22 @@ module Aws::Health
507
516
  # Before you can call this operation, you must first enable AWS Health
508
517
  # to work with AWS Organizations. To do this, call the
509
518
  # [EnableHealthServiceAccessForOrganization][1] operation from your
510
- # organization's master account.
519
+ # organization's management account.
511
520
  #
512
- # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
513
- # in the next request to return more results.
521
+ # <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
522
+ # parameter in the next request to return more results.
523
+ #
524
+ # * This operation doesn't support resource-level permissions. You
525
+ # can't use this operation to allow or deny access to specific AWS
526
+ # Health events. For more information, see [Resource- and action-based
527
+ # conditions][2] in the *AWS Health User Guide*.
514
528
  #
515
529
  # </note>
516
530
  #
517
531
  #
518
532
  #
519
533
  # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
534
+ # [2]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
520
535
  #
521
536
  # @option params [required, Array<Types::EventAccountFilter>] :organization_entity_filters
522
537
  # A JSON set of elements including the `awsAccountId` and the
@@ -713,19 +728,27 @@ module Aws::Health
713
728
  end
714
729
 
715
730
  # Returns detailed information about one or more specified events.
716
- # Information includes standard event data (Region, service, and so on,
717
- # as returned by [DescribeEvents][1]), a detailed event description, and
718
- # possible additional metadata that depends upon the nature of the
731
+ # Information includes standard event data (AWS Region, service, and so
732
+ # on, as returned by [DescribeEvents][1]), a detailed event description,
733
+ # and possible additional metadata that depends upon the nature of the
719
734
  # event. Affected entities are not included. To retrieve those, use the
720
735
  # [DescribeAffectedEntities][2] operation.
721
736
  #
722
737
  # If a specified event cannot be retrieved, an error message is returned
723
738
  # for that event.
724
739
  #
740
+ # <note markdown="1"> This operation supports resource-level permissions. You can use this
741
+ # operation to allow or deny access to specific AWS Health events. For
742
+ # more information, see [Resource- and action-based conditions][3] in
743
+ # the *AWS Health User Guide*.
744
+ #
745
+ # </note>
746
+ #
725
747
  #
726
748
  #
727
749
  # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
728
750
  # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
751
+ # [3]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
729
752
  #
730
753
  # @option params [required, Array<String>] :event_arns
731
754
  # A list of event ARNs (unique identifiers). For example:
@@ -781,7 +804,7 @@ module Aws::Health
781
804
 
782
805
  # Returns detailed information about one or more specified events for
783
806
  # one or more accounts in your organization. Information includes
784
- # standard event data (Region, service, and so on, as returned by
807
+ # standard event data (AWS Region, service, and so on, as returned by
785
808
  # [DescribeEventsForOrganization][1]), a detailed event description, and
786
809
  # possible additional metadata that depends upon the nature of the
787
810
  # event. Affected entities are not included; to retrieve those, use the
@@ -790,7 +813,7 @@ module Aws::Health
790
813
  # Before you can call this operation, you must first enable AWS Health
791
814
  # to work with AWS Organizations. To do this, call the
792
815
  # [EnableHealthServiceAccessForOrganization][3] operation from your
793
- # organization's master account.
816
+ # organization's management account.
794
817
  #
795
818
  # When you call the `DescribeEventDetailsForOrganization` operation, you
796
819
  # specify the `organizationEventDetailFilters` object in the request.
@@ -809,12 +832,20 @@ module Aws::Health
809
832
  #
810
833
  # For more information, see [Event][4].
811
834
  #
835
+ # <note markdown="1"> This operation doesn't support resource-level permissions. You can't
836
+ # use this operation to allow or deny access to specific AWS Health
837
+ # events. For more information, see [Resource- and action-based
838
+ # conditions][5] in the *AWS Health User Guide*.
839
+ #
840
+ # </note>
841
+ #
812
842
  #
813
843
  #
814
844
  # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
815
845
  # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
816
846
  # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
817
847
  # [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
848
+ # [5]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
818
849
  #
819
850
  # @option params [required, Array<Types::EventAccountFilter>] :organization_event_detail_filters
820
851
  # A set of JSON elements that includes the `awsAccountId` and the
@@ -874,15 +905,23 @@ module Aws::Health
874
905
  req.send_request(options)
875
906
  end
876
907
 
877
- # Returns the event types that meet the specified filter criteria. If no
878
- # filter criteria are specified, all event types are returned, in no
879
- # particular order.
908
+ # Returns the event types that meet the specified filter criteria. You
909
+ # can use this API operation to find information about the AWS Health
910
+ # event, such as the category, AWS service, and event code. The metadata
911
+ # for each event appears in the [EventType][1] object.
912
+ #
913
+ # If you don't specify a filter criteria, the API operation returns all
914
+ # event types, in no particular order.
880
915
  #
881
916
  # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
882
917
  # in the next request to return more results.
883
918
  #
884
919
  # </note>
885
920
  #
921
+ #
922
+ #
923
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html
924
+ #
886
925
  # @option params [Types::EventTypeFilter] :filter
887
926
  # Values to narrow the results returned.
888
927
  #
@@ -1083,7 +1122,7 @@ module Aws::Health
1083
1122
  # Before you can call this operation, you must first enable AWS Health
1084
1123
  # to work with AWS Organizations. To do this, call the
1085
1124
  # [EnableHealthServiceAccessForOrganization][5] operation from your
1086
- # organization's master AWS account.
1125
+ # organization's management account.
1087
1126
  #
1088
1127
  # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
1089
1128
  # in the next request to return more results.
@@ -1180,7 +1219,7 @@ module Aws::Health
1180
1219
  # This operation provides status information on enabling or disabling
1181
1220
  # AWS Health to work with your organization. To call this operation, you
1182
1221
  # must sign in as an IAM user, assume an IAM role, or sign in as the
1183
- # root user (not recommended) in the organization's master account.
1222
+ # root user (not recommended) in the organization's management account.
1184
1223
  #
1185
1224
  # @return [Types::DescribeHealthServiceStatusForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1186
1225
  #
@@ -1202,15 +1241,15 @@ module Aws::Health
1202
1241
  # Disables AWS Health from working with AWS Organizations. To call this
1203
1242
  # operation, you must sign in as an AWS Identity and Access Management
1204
1243
  # (IAM) user, assume an IAM role, or sign in as the root user (not
1205
- # recommended) in the organization's master AWS account. For more
1244
+ # recommended) in the organization's management account. For more
1206
1245
  # information, see [Aggregating AWS Health events][1] in the *AWS Health
1207
1246
  # User Guide*.
1208
1247
  #
1209
- # This operation doesn't remove the service-linked role (SLR) from the
1210
- # AWS master account in your organization. You must use the IAM console,
1211
- # API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For
1212
- # more information, see [Deleting a Service-Linked Role][2] in the *IAM
1213
- # User Guide*.
1248
+ # This operation doesn't remove the service-linked role from the
1249
+ # management account in your organization. You must use the IAM console,
1250
+ # API, or AWS Command Line Interface (AWS CLI) to remove the
1251
+ # service-linked role. For more information, see [Deleting a
1252
+ # Service-Linked Role][2] in the *IAM User Guide*.
1214
1253
  #
1215
1254
  # <note markdown="1"> You can also disable the organizational feature by using the
1216
1255
  # Organizations [DisableAWSServiceAccess][3] API operation. After you
@@ -1238,18 +1277,36 @@ module Aws::Health
1238
1277
  req.send_request(options)
1239
1278
  end
1240
1279
 
1241
- # Calling this operation enables AWS Health to work with AWS
1242
- # Organizations. This applies a service-linked role (SLR) to the master
1243
- # account in the organization. To call this operation, you must sign in
1244
- # as an IAM user, assume an IAM role, or sign in as the root user (not
1245
- # recommended) in the organization's master account.
1280
+ # Enables AWS Health to work with AWS Organizations. You can use the
1281
+ # organizational view feature to aggregate events from all AWS accounts
1282
+ # in your organization in a centralized location.
1246
1283
  #
1247
- # For more information, see [Aggregating AWS Health events][1] in the
1248
- # *AWS Health User Guide*.
1284
+ # This operation also creates a service-linked role for the management
1285
+ # account in the organization.
1249
1286
  #
1287
+ # <note markdown="1"> To call this operation, you must meet the following requirements:
1250
1288
  #
1289
+ # * You must have a Business or Enterprise support plan from [AWS
1290
+ # Support][1] to use the AWS Health API. If you call the AWS Health
1291
+ # API from an AWS account that doesn't have a Business or Enterprise
1292
+ # support plan, you receive a `SubscriptionRequiredException` error.
1251
1293
  #
1252
- # [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
1294
+ # * You must have permission to call this operation from the
1295
+ # organization's management account. For example IAM policies, see
1296
+ # [AWS Health identity-based policy examples][2].
1297
+ #
1298
+ # </note>
1299
+ #
1300
+ # If you don't have the required support plan, you can instead use the
1301
+ # AWS Health console to enable the organizational view feature. For more
1302
+ # information, see [Aggregating AWS Health events][3] in the *AWS Health
1303
+ # User Guide*.
1304
+ #
1305
+ #
1306
+ #
1307
+ # [1]: http://aws.amazon.com/premiumsupport/
1308
+ # [2]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html
1309
+ # [3]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
1253
1310
  #
1254
1311
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1255
1312
  #
@@ -1275,7 +1332,7 @@ module Aws::Health
1275
1332
  params: params,
1276
1333
  config: config)
1277
1334
  context[:gem_name] = 'aws-sdk-health'
1278
- context[:gem_version] = '1.32.0'
1335
+ context[:gem_version] = '1.33.0'
1279
1336
  Seahorse::Client::Request.new(handlers, context)
1280
1337
  end
1281
1338
 
@@ -1341,10 +1341,25 @@ module Aws::Health
1341
1341
  include Aws::Structure
1342
1342
  end
1343
1343
 
1344
- # Metadata about a type of event that is reported by AWS Health. Data
1345
- # consists of the category (for example, `issue`), the service (for
1346
- # example, `EC2`), and the event type code (for example,
1347
- # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`).
1344
+ # Contains the metadata about a type of event that is reported by AWS
1345
+ # Health. The `EventType` shows the category, service, and the event
1346
+ # type code of the event. For example, an `issue` might be the category,
1347
+ # `EC2` the service, and `AWS_EC2_SYSTEM_MAINTENANCE_EVENT` the event
1348
+ # type code.
1349
+ #
1350
+ # You can use the [DescribeEventTypes][1] API operation to return this
1351
+ # information about an event.
1352
+ #
1353
+ # You can also use the Amazon CloudWatch Events console to create a rule
1354
+ # so that you can get notified or take action when AWS Health delivers a
1355
+ # specific event to your AWS account. For more information, see [Monitor
1356
+ # for AWS Health events with Amazon CloudWatch Events][2] in the *AWS
1357
+ # Health User Guide*.
1358
+ #
1359
+ #
1360
+ #
1361
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
1362
+ # [2]: https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html
1348
1363
  #
1349
1364
  # @!attribute [rw] service
1350
1365
  # The AWS service that is affected by the event. For example, `EC2`,
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.32.0
4
+ version: 1.33.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-02-02 00:00:00.000000000 Z
11
+ date: 2021-02-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core