feat(client-opensearch): Amazon OpenSearch Service adds the option to…

… deploy a domain across multiple Availability Zones, with each AZ containing a complete copy of data and with nodes in one AZ acting as a standby. This option provides 99.99% availability and consistent performance in the event of infrastructure failure.
aws · May 3, 2023 · bd6c71a · bd6c71a
1 parent c28aac2
commit bd6c71a
Show file tree

Hide file tree

Showing 56 changed files with 1,215 additions and 195 deletions.
diff --git a/clients/client-opensearch/README.md b/clients/client-opensearch/README.md
@@ -358,6 +358,14 @@ DescribeDomainConfig
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/classes/describedomainconfigcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/interfaces/describedomainconfigcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/interfaces/describedomainconfigcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DescribeDomainHealth
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/classes/describedomainhealthcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/interfaces/describedomainhealthcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-opensearch/interfaces/describedomainhealthcommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-opensearch/src/OpenSearch.ts b/clients/client-opensearch/src/OpenSearch.ts
@@ -88,6 +88,11 @@ import {
   DescribeDomainConfigCommandInput,
   DescribeDomainConfigCommandOutput,
 } from "./commands/DescribeDomainConfigCommand";
+import {
+  DescribeDomainHealthCommand,
+  DescribeDomainHealthCommandInput,
+  DescribeDomainHealthCommandOutput,
+} from "./commands/DescribeDomainHealthCommand";
 import {
   DescribeDomainsCommand,
   DescribeDomainsCommandInput,
@@ -271,6 +276,7 @@ const commands = {
   DescribeDomainAutoTunesCommand,
   DescribeDomainChangeProgressCommand,
   DescribeDomainConfigCommand,
+  DescribeDomainHealthCommand,
   DescribeDomainsCommand,
   DescribeDryRunProgressCommand,
   DescribeInboundConnectionsCommand,
@@ -581,6 +587,23 @@ export interface OpenSearch {
     cb: (err: any, data?: DescribeDomainConfigCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeDomainHealthCommand}
+   */
+  describeDomainHealth(
+    args: DescribeDomainHealthCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeDomainHealthCommandOutput>;
+  describeDomainHealth(
+    args: DescribeDomainHealthCommandInput,
+    cb: (err: any, data?: DescribeDomainHealthCommandOutput) => void
+  ): void;
+  describeDomainHealth(
+    args: DescribeDomainHealthCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeDomainHealthCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeDomainsCommand}
    */

diff --git a/clients/client-opensearch/src/OpenSearchClient.ts b/clients/client-opensearch/src/OpenSearchClient.ts
@@ -94,6 +94,10 @@ import {
   DescribeDomainConfigCommandInput,
   DescribeDomainConfigCommandOutput,
 } from "./commands/DescribeDomainConfigCommand";
+import {
+  DescribeDomainHealthCommandInput,
+  DescribeDomainHealthCommandOutput,
+} from "./commands/DescribeDomainHealthCommand";
 import { DescribeDomainsCommandInput, DescribeDomainsCommandOutput } from "./commands/DescribeDomainsCommand";
 import {
   DescribeDryRunProgressCommandInput,
@@ -218,6 +222,7 @@ export type ServiceInputTypes =
   | DescribeDomainChangeProgressCommandInput
   | DescribeDomainCommandInput
   | DescribeDomainConfigCommandInput
+  | DescribeDomainHealthCommandInput
   | DescribeDomainsCommandInput
   | DescribeDryRunProgressCommandInput
   | DescribeInboundConnectionsCommandInput
@@ -275,6 +280,7 @@ export type ServiceOutputTypes =
   | DescribeDomainChangeProgressCommandOutput
   | DescribeDomainCommandOutput
   | DescribeDomainConfigCommandOutput
+  | DescribeDomainHealthCommandOutput
   | DescribeDomainsCommandOutput
   | DescribeDryRunProgressCommandOutput
   | DescribeInboundConnectionsCommandOutput

diff --git a/clients/client-opensearch/src/commands/AcceptInboundConnectionCommand.ts b/clients/client-opensearch/src/commands/AcceptInboundConnectionCommand.ts
@@ -80,13 +80,13 @@ export interface AcceptInboundConnectionCommandOutput extends AcceptInboundConne
  * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
  *  <p>An exception for trying to create more than the allowed number of resources or sub-resources.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link OpenSearchServiceException}
  * <p>Base exception class for all service exceptions from OpenSearch service.</p>

diff --git a/clients/client-opensearch/src/commands/AssociatePackageCommand.ts b/clients/client-opensearch/src/commands/AssociatePackageCommand.ts
@@ -85,7 +85,7 @@ export interface AssociatePackageCommandOutput extends AssociatePackageResponse,
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/AuthorizeVpcEndpointAccessCommand.ts b/clients/client-opensearch/src/commands/AuthorizeVpcEndpointAccessCommand.ts
@@ -65,7 +65,7 @@ export interface AuthorizeVpcEndpointAccessCommandOutput extends AuthorizeVpcEnd
  *  <p>An error occurred while processing the request.</p>
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link InternalException} (server fault)
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
@@ -74,7 +74,7 @@ export interface AuthorizeVpcEndpointAccessCommandOutput extends AuthorizeVpcEnd
  *  <p>An exception for trying to create more than the allowed number of resources or sub-resources.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts b/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts
@@ -79,7 +79,7 @@ export interface CancelServiceSoftwareUpdateCommandOutput
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/CreateDomainCommand.ts b/clients/client-opensearch/src/commands/CreateDomainCommand.ts
@@ -58,6 +58,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
  *     ColdStorageOptions: { // ColdStorageOptions
  *       Enabled: true || false, // required
  *     },
+ *     MultiAZWithStandbyEnabled: true || false,
  *   },
  *   EBSOptions: { // EBSOptions
  *     EBSEnabled: true || false,
@@ -194,6 +195,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
  * //       ColdStorageOptions: { // ColdStorageOptions
  * //         Enabled: true || false, // required
  * //       },
+ * //       MultiAZWithStandbyEnabled: true || false,
  * //     },
  * //     EBSOptions: { // EBSOptions
  * //       EBSEnabled: true || false,
@@ -309,7 +311,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
  *  <p>An error occurred while processing the request.</p>
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link InternalException} (server fault)
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>

diff --git a/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts
@@ -97,7 +97,7 @@ export interface CreateOutboundConnectionCommandOutput extends CreateOutboundCon
  * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link InternalException} (server fault)
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>

diff --git a/clients/client-opensearch/src/commands/CreateVpcEndpointCommand.ts b/clients/client-opensearch/src/commands/CreateVpcEndpointCommand.ts
@@ -90,7 +90,7 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointRespons
  *  <p>An error occurred because the client attempts to remove a resource that is currently in use.</p>
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link InternalException} (server fault)
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>

diff --git a/clients/client-opensearch/src/commands/DeleteDomainCommand.ts b/clients/client-opensearch/src/commands/DeleteDomainCommand.ts
@@ -75,6 +75,7 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
  * //       ColdStorageOptions: { // ColdStorageOptions
  * //         Enabled: true || false, // required
  * //       },
+ * //       MultiAZWithStandbyEnabled: true || false,
  * //     },
  * //     EBSOptions: { // EBSOptions
  * //       EBSEnabled: true || false,
@@ -193,7 +194,7 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/DeleteInboundConnectionCommand.ts b/clients/client-opensearch/src/commands/DeleteInboundConnectionCommand.ts
@@ -80,10 +80,10 @@ export interface DeleteInboundConnectionCommandOutput extends DeleteInboundConne
  * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link OpenSearchServiceException}
  * <p>Base exception class for all service exceptions from OpenSearch service.</p>

diff --git a/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts
@@ -84,10 +84,10 @@ export interface DeleteOutboundConnectionCommandOutput extends DeleteOutboundCon
  * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link OpenSearchServiceException}
  * <p>Base exception class for all service exceptions from OpenSearch service.</p>

diff --git a/clients/client-opensearch/src/commands/DeletePackageCommand.ts b/clients/client-opensearch/src/commands/DeletePackageCommand.ts
@@ -83,7 +83,7 @@ export interface DeletePackageCommandOutput extends DeletePackageResponse, __Met
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/DeleteVpcEndpointCommand.ts b/clients/client-opensearch/src/commands/DeleteVpcEndpointCommand.ts
@@ -65,13 +65,13 @@ export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointRespons
  *  <p>An error occurred while processing the request.</p>
  *
  * @throws {@link DisabledOperationException} (client fault)
- *  <p>An error occured because the client wanted to access a not supported operation.</p>
+ *  <p>An error occured because the client wanted to access an unsupported operation.</p>
  *
  * @throws {@link InternalException} (server fault)
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link OpenSearchServiceException}
  * <p>Base exception class for all service exceptions from OpenSearch service.</p>

diff --git a/clients/client-opensearch/src/commands/DescribeDomainAutoTunesCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainAutoTunesCommand.ts
@@ -80,7 +80,7 @@ export interface DescribeDomainAutoTunesCommandOutput extends DescribeDomainAuto
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts
@@ -89,7 +89,7 @@ export interface DescribeDomainChangeProgressCommandOutput
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/DescribeDomainCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainCommand.ts
@@ -75,6 +75,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
  * //       ColdStorageOptions: { // ColdStorageOptions
  * //         Enabled: true || false, // required
  * //       },
+ * //       MultiAZWithStandbyEnabled: true || false,
  * //     },
  * //     EBSOptions: { // EBSOptions
  * //       EBSEnabled: true || false,
@@ -193,7 +194,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>

diff --git a/clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts
@@ -73,6 +73,7 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
  * //         ColdStorageOptions: { // ColdStorageOptions
  * //           Enabled: true || false, // required
  * //         },
+ * //         MultiAZWithStandbyEnabled: true || false,
  * //       },
  * //       Status: {
  * //         CreationDate: new Date("TIMESTAMP"), // required
@@ -266,7 +267,7 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
  *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>An exception for accessing or deleting a resource that does not exist..</p>
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>