aws-sdk-health 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94be0828f8aa38fa0f6f0fbfafbce3e5b56be985b0772e68e0d219cb2c6f1c02
-  data.tar.gz: 8ee3d65144cecbd69d06c18264317129c8dd4fa8f99335814c23604f0654e58d
+  metadata.gz: 0d9d94bef06f5e4d1d9c11c6f004b97e5d21331e012b4078e2d9246500ffb443
+  data.tar.gz: ec5259084892a785e8febf2991f604e0e970be80dfdedfb5a3af0b2e744eca9b
 SHA512:
-  metadata.gz: 60f647d7c9ede4f40ede1d52cb55ed2f6c28d352f4c2d3c17dca3d33934e949d2dd5a3e09873d2a97c418b189ce13dc1eafe9a44258106e285e50a8955d4acd1
-  data.tar.gz: 3f12c8f532502235af51b0092333f28d505290513395a92fae790ff1e413cadec9903ad2ca015e6cc510cd8a242a4fa302dc0b128222caa1f5a13bffe71fb8a6
+  metadata.gz: d3cbc98af90beb015abc5687a9bcd2373f78953d2a76e478747050c7e49e7e211b0166a7993b23212a11322e5da7b3e47af78a5cea67d17804c93dff78052894
+  data.tar.gz: 9eb2d0b9293b4695672c02acc1fa1c53390007944d0abacac1050d5020c0f43bc62f06cbdaef4b62741d55fa7b3d7fe98bdccab91c35f665dc7254132efc9654

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.35.0 (2021-05-04)
+------------------
+
+* Feature - Documentation updates for health
+
 1.34.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.35.0

data/lib/aws-sdk-health.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-health/customizations'
 # @!group service
 module Aws::Health
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

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

@@ -357,10 +357,13 @@ module Aws::Health
     # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
     #
     # @option params [required, String] :event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #
     # @option params [String] :next_token
     #   If the results of a search are large, only a portion of the results
@@ -731,10 +734,10 @@ module Aws::Health
     # 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.
+    # event. Affected entities are not included. To retrieve the entities,
+    # use the [DescribeAffectedEntities][2] operation.
     #
-    # If a specified event cannot be retrieved, an error message is returned
+    # If a specified event can't be retrieved, an error message is returned
     # for that event.
     #
     # <note markdown="1"> This operation supports resource-level permissions. You can use this
@@ -803,49 +806,51 @@ module Aws::Health
     end
 
     # Returns detailed information about one or more specified events for
-    # one or more accounts in your organization. Information includes
-    # 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
-    # [DescribeAffectedEntitiesForOrganization][2] operation.
-    #
-    # Before you can call this operation, you must first enable AWS Health
+    # one or more AWS accounts in your organization. This information
+    # includes standard event data (such as the AWS Region and service), an
+    # event description, and (depending on the event) possible metadata.
+    # This operation doesn't return affected entities, such as the
+    # resources related to the event. To return affected entities, use the
+    # [DescribeAffectedEntitiesForOrganization][1] operation.
+    #
+    # <note markdown="1"> 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
+    # [EnableHealthServiceAccessForOrganization][2] operation from your
     # organization's management account.
     #
-    # When you call the `DescribeEventDetailsForOrganization` operation, you
+    #  </note>
+    #
+    # When you call the `DescribeEventDetailsForOrganization` operation,
     # specify the `organizationEventDetailFilters` object in the request.
     # Depending on the AWS Health event type, note the following
     # differences:
     #
-    # * If the event is public, the `awsAccountId` parameter must be empty.
-    #   If you specify an account ID for a public event, then an error
-    #   message is returned. That's because the event might apply to all
-    #   AWS accounts and isn't specific to an account in your organization.
+    # * To return event details for a public event, you must specify a null
+    #   value for the `awsAccountId` parameter. If you specify an account ID
+    #   for a public event, AWS Health returns an error message because
+    #   public events aren't specific to an account.
     #
-    # * If the event is specific to an account, then you must specify the
-    #   `awsAccountId` parameter in the request. If you don't specify an
-    #   account ID, an error message returns because the event is specific
-    #   to an AWS account in your organization.
+    # * To return event details for an event that is specific to an account
+    #   in your organization, you must specify the `awsAccountId` parameter
+    #   in the request. If you don't specify an account ID, AWS Health
+    #   returns an error message because the event is specific to an account
+    #   in your organization.
     #
-    # For more information, see [Event][4].
+    # For more information, see [Event][3].
     #
     # <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*.
+    # conditions][4] 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
+    # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
+    # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
+    # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
+    # [4]: 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
@@ -1286,10 +1291,10 @@ module Aws::Health
     #
     # <note markdown="1"> To call this operation, you must meet the following requirements:
     #
-    #  * You must have a Business or Enterprise support plan from [AWS
+    #  * 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.
+    #   Support plan, you receive a `SubscriptionRequiredException` error.
     #
     # * You must have permission to call this operation from the
     #   organization's management account. For example IAM policies, see
@@ -1332,7 +1337,7 @@ module Aws::Health
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-health'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -20,10 +20,13 @@ module Aws::Health
     #   @return [String]
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] entity_value
@@ -139,10 +142,13 @@ module Aws::Health
     #       }
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] next_token
@@ -869,10 +875,13 @@ module Aws::Health
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] count
@@ -986,10 +995,13 @@ module Aws::Health
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode
     #
     # @!attribute [rw] arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] service
@@ -1009,7 +1021,7 @@ module Aws::Health
     #   @return [String]
     #
     # @!attribute [rw] region
-    #   The AWS region name of the event.
+    #   The AWS Region name of the event.
     #   @return [String]
     #
     # @!attribute [rw] availability_zone
@@ -1086,10 +1098,13 @@ module Aws::Health
     #       }
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] aws_account_id
@@ -1182,17 +1197,20 @@ module Aws::Health
     end
 
     # Error information returned when a [DescribeEventDetails][1] operation
-    # cannot find a specified event.
+    # can't find a specified event.
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] error_name
@@ -1276,11 +1294,11 @@ module Aws::Health
     #   @return [Array<String>]
     #
     # @!attribute [rw] regions
-    #   A list of AWS regions.
+    #   A list of AWS Regions.
     #   @return [Array<String>]
     #
     # @!attribute [rw] availability_zones
-    #   A list of AWS availability zones.
+    #   A list of AWS Availability Zones.
     #   @return [Array<String>]
     #
     # @!attribute [rw] start_times
@@ -1441,7 +1459,7 @@ module Aws::Health
     end
 
     # Error information returned when a
-    # [DescribeAffectedEntitiesForOrganization][1] operation cannot find or
+    # [DescribeAffectedEntitiesForOrganization][1] operation can't find or
     # process a specific entity.
     #
     #
@@ -1454,10 +1472,13 @@ module Aws::Health
     #   @return [String]
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] error_name
@@ -1489,15 +1510,17 @@ module Aws::Health
     # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
     #
     # @!attribute [rw] arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] service
-    #   The AWS service that is affected by the event. For example, EC2,
-    #   RDS.
+    #   The AWS service that is affected by the event, such as EC2 and RDS.
     #   @return [String]
     #
     # @!attribute [rw] event_type_code
@@ -1631,7 +1654,7 @@ module Aws::Health
     end
 
     # Error information returned when a
-    # [DescribeEventDetailsForOrganization][1] operation cannot find a
+    # [DescribeEventDetailsForOrganization][1] operation can't find a
     # specified event.
     #
     #
@@ -1640,7 +1663,7 @@ module Aws::Health
     #
     # @!attribute [rw] aws_account_id
     #   Error information returned when a
-    #   [DescribeEventDetailsForOrganization][1] operation cannot find a
+    #   [DescribeEventDetailsForOrganization][1] operation can't find a
     #   specified event.
     #
     #
@@ -1649,10 +1672,13 @@ module Aws::Health
     #   @return [String]
     #
     # @!attribute [rw] event_arn
-    #   The unique identifier for the event. Format:
+    #   The unique identifier for the event. The event ARN has the
     #   `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
-    #   `. Example: `Example:
-    #   arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
+    #   ` format.
+    #
+    #   For example, an event ARN might look like the following:
+    #
+    #   `arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
     #   @return [String]
     #
     # @!attribute [rw] error_name
@@ -1661,6 +1687,22 @@ module Aws::Health
     #
     # @!attribute [rw] error_message
     #   A message that describes the error.
+    #
+    #   If you call the `DescribeEventDetailsForOrganization` operation and
+    #   receive one of the following errors, follow the recommendations in
+    #   the message:
+    #
+    #   * We couldn't find a public event that matches your request. To
+    #     find an event that is account specific, you must enter an AWS
+    #     account ID in the request.
+    #
+    #   * We couldn't find an account specific event for the specified AWS
+    #     account. To find an event that is public, you must enter a null
+    #     value for the AWS account ID in the request.
+    #
+    #   * Your AWS account doesn't include the AWS Support plan required to
+    #     use the AWS Health API. You must have either a Business or
+    #     Enterprise Support plan.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetailsErrorItem AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-health
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-health
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-health/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-health
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-health/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWSHealth