aws-sdk-health 1.28.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d471d435fbec6b47f325f65c663d948c34ce267b6a002245f4d4e68af2a7e9f
-  data.tar.gz: 4a9fc5891f2c3bcbb9461a3c8e1f973972daa06e94e3e24b3a9fb0886d4be111
+  metadata.gz: d800aac727d82c251d437f2372c09031fff98e7340a9e4b0cf5beff169a0ce19
+  data.tar.gz: c7cc332f1be7aa0e333e02f12a1dcf2b34670a4fe13140820e5e42708abf89e1
 SHA512:
-  metadata.gz: cd1fafd95f921c88370f8b3d1613f088b6d8152cc757ed2f2213a55adffc0464b63afc9f4acb64c72393b78d2484c14ee591c79a6df4dd4d45c40a05d80e1c8f
-  data.tar.gz: 7f8fc7b1e4aa458244aed80e5e25db1b79724da712fc4d59cf5093e68df5eb46698c104f36dff441b0232e3ff9ca04cf74f30f92daecc163897992baffac0776
+  metadata.gz: e35ed16d14b06ced5d4268b545ff4379bc5c15e1ce24a0de6eaed28ce940de492f04f765f451dc26f86c235faa589324266894c26c5690fdcfb3f93c3fea8bba
+  data.tar.gz: e131e988f3f6c28df37b95c2d97e1f177749066310a8fb751a9e22045a2349532a8f6f38b83160e9ecd7ea7c4a79546bd273877cdad27e546016099cae98db17

data/lib/aws-sdk-health.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-health/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::Health
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.33.0'
 
 end

data/lib/aws-sdk-health/client.rb

@@ -85,13 +85,28 @@ module Aws::Health
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Health
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -329,7 +344,7 @@ module Aws::Health
     # Before you can call this operation, you must first enable AWS Health
     # to work with AWS Organizations. To do this, call the
     # [EnableHealthServiceAccessForOrganization][2] operation from your
-    # organization's master account.
+    # organization's management account.
     #
     # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
     # in the next request to return more results.
@@ -400,11 +415,20 @@ module Aws::Health
     # At least one event ARN is required. Results are sorted by the
     # `lastUpdatedTime` of the entity, starting with the most recent.
     #
-    # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
-    # in the next request to return more results.
+    # <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
+    #   parameter in the next request to return more results.
+    #
+    # * This operation supports resource-level permissions. You can use this
+    #   operation to allow or deny access to specific AWS Health events. For
+    #   more information, see [Resource- and action-based conditions][1] in
+    #   the *AWS Health User Guide*.
     #
     #  </note>
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
+    #
     # @option params [required, Types::EntityFilter] :filter
     #   Values to narrow the results returned. At least one event ARN is
     #   required.
@@ -492,16 +516,22 @@ module Aws::Health
     # Before you can call this operation, you must first enable AWS Health
     # to work with AWS Organizations. To do this, call the
     # [EnableHealthServiceAccessForOrganization][1] operation from your
-    # organization's master account.
+    # organization's management account.
     #
-    # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
-    # in the next request to return more results.
+    # <note markdown="1"> * This API operation uses pagination. Specify the `nextToken`
+    #   parameter in the next request to return more results.
+    #
+    # * This operation doesn't support resource-level permissions. You
+    #   can't use this operation to allow or deny access to specific AWS
+    #   Health events. For more information, see [Resource- and action-based
+    #   conditions][2] in the *AWS Health User Guide*.
     #
     #  </note>
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
+    # [2]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
     #
     # @option params [required, Array<Types::EventAccountFilter>] :organization_entity_filters
     #   A JSON set of elements including the `awsAccountId` and the
@@ -698,19 +728,27 @@ module Aws::Health
     end
 
     # Returns detailed information about one or more specified events.
-    # Information includes standard event data (Region, service, and so on,
-    # as returned by [DescribeEvents][1]), a detailed event description, and
-    # possible additional metadata that depends upon the nature of the
+    # Information includes standard event data (AWS Region, service, and so
+    # on, as returned by [DescribeEvents][1]), a detailed event description,
+    # and possible additional metadata that depends upon the nature of the
     # event. Affected entities are not included. To retrieve those, use the
     # [DescribeAffectedEntities][2] operation.
     #
     # If a specified event cannot be retrieved, an error message is returned
     # for that event.
     #
+    # <note markdown="1"> This operation supports resource-level permissions. You can use this
+    # operation to allow or deny access to specific AWS Health events. For
+    # more information, see [Resource- and action-based conditions][3] in
+    # the *AWS Health User Guide*.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
     # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
+    # [3]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
     #
     # @option params [required, Array<String>] :event_arns
     #   A list of event ARNs (unique identifiers). For example:
@@ -766,7 +804,7 @@ module Aws::Health
 
     # Returns detailed information about one or more specified events for
     # one or more accounts in your organization. Information includes
-    # standard event data (Region, service, and so on, as returned by
+    # standard event data (AWS Region, service, and so on, as returned by
     # [DescribeEventsForOrganization][1]), a detailed event description, and
     # possible additional metadata that depends upon the nature of the
     # event. Affected entities are not included; to retrieve those, use the
@@ -775,7 +813,7 @@ module Aws::Health
     # Before you can call this operation, you must first enable AWS Health
     # to work with AWS Organizations. To do this, call the
     # [EnableHealthServiceAccessForOrganization][3] operation from your
-    # organization's master account.
+    # organization's management account.
     #
     # When you call the `DescribeEventDetailsForOrganization` operation, you
     # specify the `organizationEventDetailFilters` object in the request.
@@ -794,12 +832,20 @@ module Aws::Health
     #
     # For more information, see [Event][4].
     #
+    # <note markdown="1"> This operation doesn't support resource-level permissions. You can't
+    # use this operation to allow or deny access to specific AWS Health
+    # events. For more information, see [Resource- and action-based
+    # conditions][5] in the *AWS Health User Guide*.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
     # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
     # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
     # [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
+    # [5]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions
     #
     # @option params [required, Array<Types::EventAccountFilter>] :organization_event_detail_filters
     #   A set of JSON elements that includes the `awsAccountId` and the
@@ -859,15 +905,23 @@ module Aws::Health
       req.send_request(options)
     end
 
-    # Returns the event types that meet the specified filter criteria. If no
-    # filter criteria are specified, all event types are returned, in no
-    # particular order.
+    # Returns the event types that meet the specified filter criteria. You
+    # can use this API operation to find information about the AWS Health
+    # event, such as the category, AWS service, and event code. The metadata
+    # for each event appears in the [EventType][1] object.
+    #
+    # If you don't specify a filter criteria, the API operation returns all
+    # event types, in no particular order.
     #
     # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
     # in the next request to return more results.
     #
     #  </note>
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html
+    #
     # @option params [Types::EventTypeFilter] :filter
     #   Values to narrow the results returned.
     #
@@ -1068,7 +1122,7 @@ module Aws::Health
     # Before you can call this operation, you must first enable AWS Health
     # to work with AWS Organizations. To do this, call the
     # [EnableHealthServiceAccessForOrganization][5] operation from your
-    # organization's master AWS account.
+    # organization's management account.
     #
     # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
     # in the next request to return more results.
@@ -1165,7 +1219,7 @@ module Aws::Health
     # This operation provides status information on enabling or disabling
     # AWS Health to work with your organization. To call this operation, you
     # must sign in as an IAM user, assume an IAM role, or sign in as the
-    # root user (not recommended) in the organization's master account.
+    # root user (not recommended) in the organization's management account.
     #
     # @return [Types::DescribeHealthServiceStatusForOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1187,15 +1241,15 @@ module Aws::Health
     # Disables AWS Health from working with AWS Organizations. To call this
     # operation, you must sign in as an AWS Identity and Access Management
     # (IAM) user, assume an IAM role, or sign in as the root user (not
-    # recommended) in the organization's master AWS account. For more
+    # recommended) in the organization's management account. For more
     # information, see [Aggregating AWS Health events][1] in the *AWS Health
     # User Guide*.
     #
-    # This operation doesn't remove the service-linked role (SLR) from the
-    # AWS master account in your organization. You must use the IAM console,
-    # API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For
-    # more information, see [Deleting a Service-Linked Role][2] in the *IAM
-    # User Guide*.
+    # This operation doesn't remove the service-linked role from the
+    # management account in your organization. You must use the IAM console,
+    # API, or AWS Command Line Interface (AWS CLI) to remove the
+    # service-linked role. For more information, see [Deleting a
+    # Service-Linked Role][2] in the *IAM User Guide*.
     #
     # <note markdown="1"> You can also disable the organizational feature by using the
     # Organizations [DisableAWSServiceAccess][3] API operation. After you
@@ -1223,18 +1277,36 @@ module Aws::Health
       req.send_request(options)
     end
 
-    # Calling this operation enables AWS Health to work with AWS
-    # Organizations. This applies a service-linked role (SLR) to the master
-    # account in the organization. To call this operation, you must sign in
-    # as an IAM user, assume an IAM role, or sign in as the root user (not
-    # recommended) in the organization's master account.
+    # Enables AWS Health to work with AWS Organizations. You can use the
+    # organizational view feature to aggregate events from all AWS accounts
+    # in your organization in a centralized location.
     #
-    # For more information, see [Aggregating AWS Health events][1] in the
-    # *AWS Health User Guide*.
+    # This operation also creates a service-linked role for the management
+    # account in the organization.
     #
+    # <note markdown="1"> To call this operation, you must meet the following requirements:
     #
+    #  * You must have a Business or Enterprise support plan from [AWS
+    #   Support][1] to use the AWS Health API. If you call the AWS Health
+    #   API from an AWS account that doesn't have a Business or Enterprise
+    #   support plan, you receive a `SubscriptionRequiredException` error.
     #
-    # [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
+    # * You must have permission to call this operation from the
+    #   organization's management account. For example IAM policies, see
+    #   [AWS Health identity-based policy examples][2].
+    #
+    #  </note>
+    #
+    # If you don't have the required support plan, you can instead use the
+    # AWS Health console to enable the organizational view feature. For more
+    # information, see [Aggregating AWS Health events][3] in the *AWS Health
+    # User Guide*.
+    #
+    #
+    #
+    # [1]: http://aws.amazon.com/premiumsupport/
+    # [2]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html
+    # [3]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1260,7 +1332,7 @@ module Aws::Health
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-health'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.33.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-health/types.rb

@@ -1341,10 +1341,25 @@ module Aws::Health
       include Aws::Structure
     end
 
-    # Metadata about a type of event that is reported by AWS Health. Data
-    # consists of the category (for example, `issue`), the service (for
-    # example, `EC2`), and the event type code (for example,
-    # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`).
+    # Contains the metadata about a type of event that is reported by AWS
+    # Health. The `EventType` shows the category, service, and the event
+    # type code of the event. For example, an `issue` might be the category,
+    # `EC2` the service, and `AWS_EC2_SYSTEM_MAINTENANCE_EVENT` the event
+    # type code.
+    #
+    # You can use the [DescribeEventTypes][1] API operation to return this
+    # information about an event.
+    #
+    # You can also use the Amazon CloudWatch Events console to create a rule
+    # so that you can get notified or take action when AWS Health delivers a
+    # specific event to your AWS account. For more information, see [Monitor
+    # for AWS Health events with Amazon CloudWatch Events][2] in the *AWS
+    # Health User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
+    # [2]: https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html
     #
     # @!attribute [rw] service
     #   The AWS service that is affected by the event. For example, `EC2`,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-health
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement