feat(client-health): Add support for regional endpoints

aws · May 11, 2023 · e0f0af1 · e0f0af1
1 parent cdc4030
commit e0f0af1
Show file tree

Hide file tree

Showing 18 changed files with 800 additions and 961 deletions.
diff --git a/clients/client-health/README.md b/clients/client-health/README.md
@@ -8,28 +8,23 @@ AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.
 
 <fullname>Health</fullname>
 
-<p>The Health API provides programmatic access to the Health information that
-appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
-can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
-<note>
-<ul>
-<li>
-<p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
-API. If you call the Health API from an Amazon Web Services account that
-doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
+<p>The Health API provides access to the Health information that appears in the
+<a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
+the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
+<p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
+Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
 <code>SubscriptionRequiredException</code> error.</p>
-</li>
-<li>
-<p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
-call the Health API operations. Health supports a multi-Region
-application architecture and has two regional endpoints in an active-passive
-configuration. You can use the high availability endpoint example to determine
-which Amazon Web Services Region is active, so that you can get the latest information from the
-API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the
-<i>Health User Guide</i>.</p>
-</li>
-</ul>
-</note>
+<p>For API access, you need an access key ID and a secret access key. Use temporary
+credentials instead of long-term access keys when possible. Temporary credentials include
+an access key ID, a secret access key, and a security token that indicates when the
+credentials expire. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best practices for managing
+Amazon Web Services access keys</a> in the <i>Amazon Web Services General Reference</i>.</p>
+<p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the
+Health API operations. Health supports a multi-Region application architecture
+and has two regional endpoints in an active-passive configuration. You can use the high
+availability endpoint example to determine which Amazon Web Services Region is active, so that you can
+get the latest information from the API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health
+API</a> in the <i>Health User Guide</i>.</p>
 <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
 Process</a>.</p>
 <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational

diff --git a/clients/client-health/src/Health.ts b/clients/client-health/src/Health.ts
@@ -308,29 +308,23 @@ export interface Health {
 /**
  * @public
  * <fullname>Health</fullname>
- *
- *          <p>The Health API provides programmatic access to the Health information that
- *          appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
- *          can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
- *          <note>
- *             <ul>
- *                <li>
- *                   <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
- *                   API. If you call the Health API from an Amazon Web Services account that
- *                   doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
- *                      <code>SubscriptionRequiredException</code> error.</p>
- *                </li>
- *                <li>
- *                   <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
- *                   call the Health API operations. Health supports a multi-Region
- *                   application architecture and has two regional endpoints in an active-passive
- *                   configuration. You can use the high availability endpoint example to determine
- *                   which Amazon Web Services Region is active, so that you can get the latest information from the
- *                   API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the
- *                      <i>Health User Guide</i>.</p>
- *                </li>
- *             </ul>
- *          </note>
+ *          <p>The Health API provides access to the Health information that appears in the
+ *             <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
+ *          the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
+ *          <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
+ *             Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
+ *             <code>SubscriptionRequiredException</code> error.</p>
+ *          <p>For API access, you need an access key ID and a secret access key. Use temporary
+ *          credentials instead of long-term access keys when possible. Temporary credentials include
+ *          an access key ID, a secret access key, and a security token that indicates when the
+ *          credentials expire. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best practices for managing
+ *             Amazon Web Services access keys</a> in the <i>Amazon Web Services General Reference</i>.</p>
+ *          <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the
+ *          Health API operations. Health supports a multi-Region application architecture
+ *          and has two regional endpoints in an active-passive configuration. You can use the high
+ *          availability endpoint example to determine which Amazon Web Services Region is active, so that you can
+ *          get the latest information from the API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health
+ *             API</a> in the <i>Health User Guide</i>.</p>
  *          <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
  *             Process</a>.</p>
  *          <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational

diff --git a/clients/client-health/src/HealthClient.ts b/clients/client-health/src/HealthClient.ts
@@ -304,29 +304,23 @@ export interface HealthClientResolvedConfig extends HealthClientResolvedConfigTy
 /**
  * @public
  * <fullname>Health</fullname>
- *
- *          <p>The Health API provides programmatic access to the Health information that
- *          appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
- *          can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
- *          <note>
- *             <ul>
- *                <li>
- *                   <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
- *                   API. If you call the Health API from an Amazon Web Services account that
- *                   doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
- *                      <code>SubscriptionRequiredException</code> error.</p>
- *                </li>
- *                <li>
- *                   <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
- *                   call the Health API operations. Health supports a multi-Region
- *                   application architecture and has two regional endpoints in an active-passive
- *                   configuration. You can use the high availability endpoint example to determine
- *                   which Amazon Web Services Region is active, so that you can get the latest information from the
- *                   API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the
- *                      <i>Health User Guide</i>.</p>
- *                </li>
- *             </ul>
- *          </note>
+ *          <p>The Health API provides access to the Health information that appears in the
+ *             <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
+ *          the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
+ *          <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
+ *             Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
+ *             <code>SubscriptionRequiredException</code> error.</p>
+ *          <p>For API access, you need an access key ID and a secret access key. Use temporary
+ *          credentials instead of long-term access keys when possible. Temporary credentials include
+ *          an access key ID, a secret access key, and a security token that indicates when the
+ *          credentials expire. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best practices for managing
+ *             Amazon Web Services access keys</a> in the <i>Amazon Web Services General Reference</i>.</p>
+ *          <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the
+ *          Health API operations. Health supports a multi-Region application architecture
+ *          and has two regional endpoints in an active-passive configuration. You can use the high
+ *          availability endpoint example to determine which Amazon Web Services Region is active, so that you can
+ *          get the latest information from the API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health
+ *             API</a> in the <i>Health User Guide</i>.</p>
  *          <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
  *             Process</a>.</p>
  *          <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational

diff --git a/clients/client-health/src/commands/DescribeAffectedAccountsForOrganizationCommand.ts b/clients/client-health/src/commands/DescribeAffectedAccountsForOrganizationCommand.ts
@@ -67,7 +67,7 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput
  * //   affectedAccounts: [ // affectedAccountsList
  * //     "STRING_VALUE",
  * //   ],
- * //   eventScopeCode: "STRING_VALUE",
+ * //   eventScopeCode: "PUBLIC" || "ACCOUNT_SPECIFIC" || "NONE",
  * //   nextToken: "STRING_VALUE",
  * // };
  *

diff --git a/clients/client-health/src/commands/DescribeAffectedEntitiesCommand.ts b/clients/client-health/src/commands/DescribeAffectedEntitiesCommand.ts
@@ -34,11 +34,10 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
  * @public
  * <p>Returns a list of entities that have been affected by the specified events, based on the
  *          specified filter criteria. Entities can refer to individual customer resources, groups of
- *          customer resources, or any other construct, depending on the Amazon Web Services service. Events that
+ *          customer resources, or any other construct, depending on the Amazon Web Service. Events that
  *          have impact beyond that of the affected entities, or where the extent of impact is unknown,
  *          include at least one entity indicating this.</p>
  *          <p>At least one event ARN is required.</p>
- *
  *          <note>
  *             <ul>
  *                <li>
@@ -79,7 +78,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
  *       },
  *     ],
  *     statusCodes: [ // entityStatusCodeList
- *       "STRING_VALUE",
+ *       "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN",
  *     ],
  *   },
  *   locale: "STRING_VALUE",
@@ -97,7 +96,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
  * //       entityUrl: "STRING_VALUE",
  * //       awsAccountId: "STRING_VALUE",
  * //       lastUpdatedTime: new Date("TIMESTAMP"),
- * //       statusCode: "STRING_VALUE",
+ * //       statusCode: "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN",
  * //       tags: { // tagSet
  * //         "<keys>": "STRING_VALUE",
  * //       },

diff --git a/clients/client-health/src/commands/DescribeAffectedEntitiesForOrganizationCommand.ts b/clients/client-health/src/commands/DescribeAffectedEntitiesForOrganizationCommand.ts
@@ -44,7 +44,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
  * <p>Returns a list of entities that have been affected by one or more events for one or more
  *          accounts in your organization in Organizations, based on the filter criteria. Entities can refer
  *          to individual customer resources, groups of customer resources, or any other construct,
- *          depending on the Amazon Web Services service.</p>
+ *          depending on the Amazon Web Service.</p>
  *          <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
  *          <p>Before you can call this operation, you must first enable Health to work with
  *          Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
@@ -59,7 +59,6 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
  *                   information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
  *                </li>
  *             </ul>
- *
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -89,7 +88,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
  * //       entityUrl: "STRING_VALUE",
  * //       awsAccountId: "STRING_VALUE",
  * //       lastUpdatedTime: new Date("TIMESTAMP"),
- * //       statusCode: "STRING_VALUE",
+ * //       statusCode: "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN",
  * //       tags: { // tagSet
  * //         "<keys>": "STRING_VALUE",
  * //       },

diff --git a/clients/client-health/src/commands/DescribeEventAggregatesCommand.ts b/clients/client-health/src/commands/DescribeEventAggregatesCommand.ts
@@ -86,18 +86,18 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre
  *       "STRING_VALUE",
  *     ],
  *     eventTypeCategories: [ // eventTypeCategoryList2
- *       "STRING_VALUE",
+ *       "issue" || "accountNotification" || "scheduledChange" || "investigation",
  *     ],
  *     tags: [ // tagFilter
  *       { // tagSet
  *         "<keys>": "STRING_VALUE",
  *       },
  *     ],
  *     eventStatusCodes: [ // eventStatusCodeList
- *       "STRING_VALUE",
+ *       "open" || "closed" || "upcoming",
  *     ],
  *   },
- *   aggregateField: "STRING_VALUE", // required
+ *   aggregateField: "eventTypeCategory", // required
  *   maxResults: Number("int"),
  *   nextToken: "STRING_VALUE",
  * };

diff --git a/clients/client-health/src/commands/DescribeEventDetailsCommand.ts b/clients/client-health/src/commands/DescribeEventDetailsCommand.ts
@@ -63,14 +63,14 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
  * //         arn: "STRING_VALUE",
  * //         service: "STRING_VALUE",
  * //         eventTypeCode: "STRING_VALUE",
- * //         eventTypeCategory: "STRING_VALUE",
+ * //         eventTypeCategory: "issue" || "accountNotification" || "scheduledChange" || "investigation",
  * //         region: "STRING_VALUE",
  * //         availabilityZone: "STRING_VALUE",
  * //         startTime: new Date("TIMESTAMP"),
  * //         endTime: new Date("TIMESTAMP"),
  * //         lastUpdatedTime: new Date("TIMESTAMP"),
- * //         statusCode: "STRING_VALUE",
- * //         eventScopeCode: "STRING_VALUE",
+ * //         statusCode: "open" || "closed" || "upcoming",
+ * //         eventScopeCode: "PUBLIC" || "ACCOUNT_SPECIFIC" || "NONE",
  * //       },
  * //       eventDescription: { // EventDescription
  * //         latestDescription: "STRING_VALUE",

diff --git a/clients/client-health/src/commands/DescribeEventDetailsForOrganizationCommand.ts b/clients/client-health/src/commands/DescribeEventDetailsForOrganizationCommand.ts
@@ -68,7 +68,6 @@ export interface DescribeEventDetailsForOrganizationCommandOutput
  *             </li>
  *          </ul>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
- *
  *          <note>
  *             <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more
  *                   information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
@@ -98,14 +97,14 @@ export interface DescribeEventDetailsForOrganizationCommandOutput
  * //         arn: "STRING_VALUE",
  * //         service: "STRING_VALUE",
  * //         eventTypeCode: "STRING_VALUE",
- * //         eventTypeCategory: "STRING_VALUE",
+ * //         eventTypeCategory: "issue" || "accountNotification" || "scheduledChange" || "investigation",
  * //         region: "STRING_VALUE",
  * //         availabilityZone: "STRING_VALUE",
  * //         startTime: new Date("TIMESTAMP"),
  * //         endTime: new Date("TIMESTAMP"),
  * //         lastUpdatedTime: new Date("TIMESTAMP"),
- * //         statusCode: "STRING_VALUE",
- * //         eventScopeCode: "STRING_VALUE",
+ * //         statusCode: "open" || "closed" || "upcoming",
+ * //         eventScopeCode: "PUBLIC" || "ACCOUNT_SPECIFIC" || "NONE",
  * //       },
  * //       eventDescription: { // EventDescription
  * //         latestDescription: "STRING_VALUE",