From bd6c71a898ce79383e0be842b58718ddf48888a2 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 3 May 2023 19:55:42 +0000 Subject: [PATCH] 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. --- clients/client-opensearch/README.md | 8 + clients/client-opensearch/src/OpenSearch.ts | 23 + .../client-opensearch/src/OpenSearchClient.ts | 6 + .../AcceptInboundConnectionCommand.ts | 4 +- .../src/commands/AssociatePackageCommand.ts | 2 +- .../AuthorizeVpcEndpointAccessCommand.ts | 4 +- .../CancelServiceSoftwareUpdateCommand.ts | 2 +- .../src/commands/CreateDomainCommand.ts | 4 +- .../CreateOutboundConnectionCommand.ts | 2 +- .../src/commands/CreateVpcEndpointCommand.ts | 2 +- .../src/commands/DeleteDomainCommand.ts | 3 +- .../DeleteInboundConnectionCommand.ts | 4 +- .../DeleteOutboundConnectionCommand.ts | 4 +- .../src/commands/DeletePackageCommand.ts | 2 +- .../src/commands/DeleteVpcEndpointCommand.ts | 4 +- .../DescribeDomainAutoTunesCommand.ts | 2 +- .../DescribeDomainChangeProgressCommand.ts | 2 +- .../src/commands/DescribeDomainCommand.ts | 3 +- .../commands/DescribeDomainConfigCommand.ts | 3 +- .../commands/DescribeDomainHealthCommand.ts | 178 +++++ .../src/commands/DescribeDomainsCommand.ts | 1 + .../commands/DescribeDryRunProgressCommand.ts | 5 +- .../DescribeInboundConnectionsCommand.ts | 4 +- .../DescribeInstanceTypeLimitsCommand.ts | 2 +- .../DescribeOutboundConnectionsCommand.ts | 4 +- .../src/commands/DescribePackagesCommand.ts | 2 +- ...escribeReservedInstanceOfferingsCommand.ts | 4 +- .../DescribeReservedInstancesCommand.ts | 4 +- .../commands/DescribeVpcEndpointsCommand.ts | 2 +- .../src/commands/DissociatePackageCommand.ts | 2 +- .../commands/GetCompatibleVersionsCommand.ts | 4 +- .../GetPackageVersionHistoryCommand.ts | 6 +- .../src/commands/GetUpgradeHistoryCommand.ts | 4 +- .../src/commands/GetUpgradeStatusCommand.ts | 4 +- .../commands/ListDomainsForPackageCommand.ts | 2 +- .../ListInstanceTypeDetailsCommand.ts | 7 +- .../commands/ListPackagesForDomainCommand.ts | 2 +- .../commands/ListScheduledActionsCommand.ts | 4 +- .../src/commands/ListTagsCommand.ts | 2 +- .../src/commands/ListVersionsCommand.ts | 2 +- .../commands/ListVpcEndpointAccessCommand.ts | 4 +- .../src/commands/ListVpcEndpointsCommand.ts | 2 +- .../ListVpcEndpointsForDomainCommand.ts | 4 +- ...PurchaseReservedInstanceOfferingCommand.ts | 4 +- .../RejectInboundConnectionCommand.ts | 4 +- .../RevokeVpcEndpointAccessCommand.ts | 4 +- .../StartServiceSoftwareUpdateCommand.ts | 2 +- .../src/commands/UpdateDomainConfigCommand.ts | 4 +- .../src/commands/UpdatePackageCommand.ts | 2 +- .../commands/UpdateScheduledActionCommand.ts | 2 +- .../src/commands/UpdateVpcEndpointCommand.ts | 4 +- .../src/commands/UpgradeDomainCommand.ts | 4 +- .../client-opensearch/src/commands/index.ts | 1 + .../client-opensearch/src/models/models_0.ts | 296 +++++++- .../src/protocols/Aws_restJson1.ts | 112 ++++ .../sdk-codegen/aws-models/opensearch.json | 632 +++++++++++++++--- 56 files changed, 1215 insertions(+), 195 deletions(-) create mode 100644 clients/client-opensearch/src/commands/DescribeDomainHealthCommand.ts diff --git a/clients/client-opensearch/README.md b/clients/client-opensearch/README.md index 0431277048a0..db72f2a7d320 100644 --- 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) + +
+ +DescribeDomainHealth + + +[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) +
diff --git a/clients/client-opensearch/src/OpenSearch.ts b/clients/client-opensearch/src/OpenSearch.ts index 7507c34e3428..8f2221c374c9 100644 --- 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; + 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 index 2769e6e13c54..184dfb418963 100644 --- 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 index 969be6739978..8fc58ced976e 100644 --- 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) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link LimitExceededException} (client fault) *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/AssociatePackageCommand.ts b/clients/client-opensearch/src/commands/AssociatePackageCommand.ts index af476a4ccbc6..c742cd82717a 100644 --- 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, *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/AuthorizeVpcEndpointAccessCommand.ts b/clients/client-opensearch/src/commands/AuthorizeVpcEndpointAccessCommand.ts index 3b753bee9183..d120a0b71eee 100644 --- 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 *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

@@ -74,7 +74,7 @@ export interface AuthorizeVpcEndpointAccessCommandOutput extends AuthorizeVpcEnd *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts b/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts index 18bb5681ab7b..e66e7dbec713 100644 --- a/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts +++ b/clients/client-opensearch/src/commands/CancelServiceSoftwareUpdateCommand.ts @@ -79,7 +79,7 @@ export interface CancelServiceSoftwareUpdateCommandOutput *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/CreateDomainCommand.ts b/clients/client-opensearch/src/commands/CreateDomainCommand.ts index 52155bf94166..526e32d3855f 100644 --- 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 *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

diff --git a/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts index 525a53ed780d..d1953378ff7a 100644 --- 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) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

diff --git a/clients/client-opensearch/src/commands/CreateVpcEndpointCommand.ts b/clients/client-opensearch/src/commands/CreateVpcEndpointCommand.ts index cf3aa0e7c508..9618e227a9c5 100644 --- 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 *

An error occurred because the client attempts to remove a resource that is currently in use.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

diff --git a/clients/client-opensearch/src/commands/DeleteDomainCommand.ts b/clients/client-opensearch/src/commands/DeleteDomainCommand.ts index e1652ad55d0e..7da0ba625dc8 100644 --- 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 *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DeleteInboundConnectionCommand.ts b/clients/client-opensearch/src/commands/DeleteInboundConnectionCommand.ts index 37e56fcb75f0..e8731d20276a 100644 --- 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) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts index 83ab8def9f3d..d505bb9d02e3 100644 --- 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) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/DeletePackageCommand.ts b/clients/client-opensearch/src/commands/DeletePackageCommand.ts index 4de6fd40f5ee..173aa94ec96c 100644 --- 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 *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DeleteVpcEndpointCommand.ts b/clients/client-opensearch/src/commands/DeleteVpcEndpointCommand.ts index 84fd484658ac..4e220b600618 100644 --- 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 *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/DescribeDomainAutoTunesCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainAutoTunesCommand.ts index 9e6401f8a5ef..4b4511392472 100644 --- 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 *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts index 2f0639ba10a8..1d86ecdf2061 100644 --- a/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts @@ -89,7 +89,7 @@ export interface DescribeDomainChangeProgressCommandOutput *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeDomainCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainCommand.ts index ce8e232b0620..8dc70edd41fb 100644 --- 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 *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts index 2b938b3ccdb9..987d350c49d2 100644 --- 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 *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeDomainHealthCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainHealthCommand.ts new file mode 100644 index 000000000000..938e32072662 --- /dev/null +++ b/clients/client-opensearch/src/commands/DescribeDomainHealthCommand.ts @@ -0,0 +1,178 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { DescribeDomainHealthRequest, DescribeDomainHealthResponse } from "../models/models_0"; +import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient"; +import { de_DescribeDomainHealthCommand, se_DescribeDomainHealthCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + * + * The input for {@link DescribeDomainHealthCommand}. + */ +export interface DescribeDomainHealthCommandInput extends DescribeDomainHealthRequest {} +/** + * @public + * + * The output of {@link DescribeDomainHealthCommand}. + */ +export interface DescribeDomainHealthCommandOutput extends DescribeDomainHealthResponse, __MetadataBearer {} + +/** + * @public + *

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, DescribeDomainHealthCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, DescribeDomainHealthCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // DescribeDomainHealthRequest + * DomainName: "STRING_VALUE", // required + * }; + * const command = new DescribeDomainHealthCommand(input); + * const response = await client.send(command); + * // { // DescribeDomainHealthResponse + * // DomainState: "Active" || "Processing" || "NotAvailable", + * // AvailabilityZoneCount: "STRING_VALUE", + * // ActiveAvailabilityZoneCount: "STRING_VALUE", + * // StandByAvailabilityZoneCount: "STRING_VALUE", + * // DataNodeCount: "STRING_VALUE", + * // DedicatedMaster: true || false, + * // MasterEligibleNodeCount: "STRING_VALUE", + * // WarmNodeCount: "STRING_VALUE", + * // MasterNode: "Available" || "UnAvailable", + * // ClusterHealth: "Red" || "Yellow" || "Green" || "NotAvailable", + * // TotalShards: "STRING_VALUE", + * // TotalUnAssignedShards: "STRING_VALUE", + * // EnvironmentInformation: [ // EnvironmentInfoList + * // { // EnvironmentInfo + * // AvailabilityZoneInformation: [ // AvailabilityZoneInfoList + * // { // AvailabilityZoneInfo + * // AvailabilityZoneName: "STRING_VALUE", + * // ZoneStatus: "Active" || "StandBy" || "NotAvailable", + * // ConfiguredDataNodeCount: "STRING_VALUE", + * // AvailableDataNodeCount: "STRING_VALUE", + * // TotalShards: "STRING_VALUE", + * // TotalUnAssignedShards: "STRING_VALUE", + * // }, + * // ], + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeDomainHealthCommandInput - {@link DescribeDomainHealthCommandInput} + * @returns {@link DescribeDomainHealthCommandOutput} + * @see {@link DescribeDomainHealthCommandInput} for command's `input` shape. + * @see {@link DescribeDomainHealthCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *

An error occurred while processing the request.

+ * + * @throws {@link DisabledOperationException} (client fault) + *

An error occured because the client wanted to access an unsupported operation.

+ * + * @throws {@link InternalException} (server fault) + *

Request processing failed because of an unknown error, exception, or internal failure.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

An exception for accessing or deleting a resource that doesn't exist.

+ * + * @throws {@link ValidationException} (client fault) + *

An exception for accessing or deleting a resource that doesn't exist.

+ * + * @throws {@link OpenSearchServiceException} + *

Base exception class for all service exceptions from OpenSearch service.

+ * + */ +export class DescribeDomainHealthCommand extends $Command< + DescribeDomainHealthCommandInput, + DescribeDomainHealthCommandOutput, + OpenSearchClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeDomainHealthCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: OpenSearchClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DescribeDomainHealthCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "OpenSearchClient"; + const commandName = "DescribeDomainHealthCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DescribeDomainHealthCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DescribeDomainHealthCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DescribeDomainHealthCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-opensearch/src/commands/DescribeDomainsCommand.ts b/clients/client-opensearch/src/commands/DescribeDomainsCommand.ts index 878c01687182..f635de90ee5a 100644 --- a/clients/client-opensearch/src/commands/DescribeDomainsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeDomainsCommand.ts @@ -78,6 +78,7 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _ * // ColdStorageOptions: { // ColdStorageOptions * // Enabled: true || false, // required * // }, + * // MultiAZWithStandbyEnabled: true || false, * // }, * // EBSOptions: { // EBSOptions * // EBSEnabled: true || false, diff --git a/clients/client-opensearch/src/commands/DescribeDryRunProgressCommand.ts b/clients/client-opensearch/src/commands/DescribeDryRunProgressCommand.ts index 6fc90c5a404d..483128cfe996 100644 --- a/clients/client-opensearch/src/commands/DescribeDryRunProgressCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeDryRunProgressCommand.ts @@ -89,6 +89,7 @@ export interface DescribeDryRunProgressCommandOutput extends DescribeDryRunProgr * // ColdStorageOptions: { // ColdStorageOptions * // Enabled: true || false, // required * // }, + * // MultiAZWithStandbyEnabled: true || false, * // }, * // EBSOptions: { // EBSOptions * // EBSEnabled: true || false, @@ -208,13 +209,13 @@ export interface DescribeDryRunProgressCommandOutput extends DescribeDryRunProgr *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeInboundConnectionsCommand.ts b/clients/client-opensearch/src/commands/DescribeInboundConnectionsCommand.ts index 9385cf66a0b9..c46709f901c5 100644 --- a/clients/client-opensearch/src/commands/DescribeInboundConnectionsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeInboundConnectionsCommand.ts @@ -92,10 +92,10 @@ export interface DescribeInboundConnectionsCommandOutput extends DescribeInbound * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InvalidPaginationTokenException} (client fault) - *

The request processing has failed because you provided an invalid pagination token.

+ *

Request processing failed because you provided an invalid pagination token.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/DescribeInstanceTypeLimitsCommand.ts b/clients/client-opensearch/src/commands/DescribeInstanceTypeLimitsCommand.ts index f2191f484019..f903fc55986c 100644 --- a/clients/client-opensearch/src/commands/DescribeInstanceTypeLimitsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeInstanceTypeLimitsCommand.ts @@ -103,7 +103,7 @@ export interface DescribeInstanceTypeLimitsCommandOutput extends DescribeInstanc *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts b/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts index c41dd55a8ed7..4e9f3f4dbaef 100644 --- a/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts @@ -101,10 +101,10 @@ export interface DescribeOutboundConnectionsCommandOutput * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InvalidPaginationTokenException} (client fault) - *

The request processing has failed because you provided an invalid pagination token.

+ *

Request processing failed because you provided an invalid pagination token.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/DescribePackagesCommand.ts b/clients/client-opensearch/src/commands/DescribePackagesCommand.ts index bc632e3bb724..4ce05d895db2 100644 --- a/clients/client-opensearch/src/commands/DescribePackagesCommand.ts +++ b/clients/client-opensearch/src/commands/DescribePackagesCommand.ts @@ -92,7 +92,7 @@ export interface DescribePackagesCommandOutput extends DescribePackagesResponse, *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeReservedInstanceOfferingsCommand.ts b/clients/client-opensearch/src/commands/DescribeReservedInstanceOfferingsCommand.ts index c82e6e4ca079..a5a49c8be00c 100644 --- a/clients/client-opensearch/src/commands/DescribeReservedInstanceOfferingsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeReservedInstanceOfferingsCommand.ts @@ -85,13 +85,13 @@ export interface DescribeReservedInstanceOfferingsCommandOutput * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeReservedInstancesCommand.ts b/clients/client-opensearch/src/commands/DescribeReservedInstancesCommand.ts index 6c9f480a260d..72b0db3335f5 100644 --- a/clients/client-opensearch/src/commands/DescribeReservedInstancesCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeReservedInstancesCommand.ts @@ -84,13 +84,13 @@ export interface DescribeReservedInstancesCommandOutput extends DescribeReserved * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/DescribeVpcEndpointsCommand.ts b/clients/client-opensearch/src/commands/DescribeVpcEndpointsCommand.ts index 8f990b24a58d..6e059227b38d 100644 --- a/clients/client-opensearch/src/commands/DescribeVpcEndpointsCommand.ts +++ b/clients/client-opensearch/src/commands/DescribeVpcEndpointsCommand.ts @@ -89,7 +89,7 @@ export interface DescribeVpcEndpointsCommandOutput extends DescribeVpcEndpointsR *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

diff --git a/clients/client-opensearch/src/commands/DissociatePackageCommand.ts b/clients/client-opensearch/src/commands/DissociatePackageCommand.ts index 60bc792c370a..4dd4052b9505 100644 --- a/clients/client-opensearch/src/commands/DissociatePackageCommand.ts +++ b/clients/client-opensearch/src/commands/DissociatePackageCommand.ts @@ -86,7 +86,7 @@ export interface DissociatePackageCommandOutput extends DissociatePackageRespons *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/GetCompatibleVersionsCommand.ts b/clients/client-opensearch/src/commands/GetCompatibleVersionsCommand.ts index 730b996479f7..61f54f865a9a 100644 --- a/clients/client-opensearch/src/commands/GetCompatibleVersionsCommand.ts +++ b/clients/client-opensearch/src/commands/GetCompatibleVersionsCommand.ts @@ -68,13 +68,13 @@ export interface GetCompatibleVersionsCommandOutput extends GetCompatibleVersion *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/GetPackageVersionHistoryCommand.ts b/clients/client-opensearch/src/commands/GetPackageVersionHistoryCommand.ts index ec3d37d01d46..2e9f9ebafbf8 100644 --- a/clients/client-opensearch/src/commands/GetPackageVersionHistoryCommand.ts +++ b/clients/client-opensearch/src/commands/GetPackageVersionHistoryCommand.ts @@ -32,8 +32,8 @@ export interface GetPackageVersionHistoryCommandOutput extends GetPackageVersion /** * @public - *

Returns a list of Amazon OpenSearch Service package versions, along with their creation time - * and commit message. For more information, see Custom packages for Amazon + *

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the + * package is a zip plugin package). For more information, see Custom packages for Amazon * OpenSearch Service.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -78,7 +78,7 @@ export interface GetPackageVersionHistoryCommandOutput extends GetPackageVersion *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/GetUpgradeHistoryCommand.ts b/clients/client-opensearch/src/commands/GetUpgradeHistoryCommand.ts index f26175bf9f95..9dd0592dec3a 100644 --- a/clients/client-opensearch/src/commands/GetUpgradeHistoryCommand.ts +++ b/clients/client-opensearch/src/commands/GetUpgradeHistoryCommand.ts @@ -80,13 +80,13 @@ export interface GetUpgradeHistoryCommandOutput extends GetUpgradeHistoryRespons *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/GetUpgradeStatusCommand.ts b/clients/client-opensearch/src/commands/GetUpgradeStatusCommand.ts index 172e8470c0c1..36065625359b 100644 --- a/clients/client-opensearch/src/commands/GetUpgradeStatusCommand.ts +++ b/clients/client-opensearch/src/commands/GetUpgradeStatusCommand.ts @@ -63,13 +63,13 @@ export interface GetUpgradeStatusCommandOutput extends GetUpgradeStatusResponse, *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListDomainsForPackageCommand.ts b/clients/client-opensearch/src/commands/ListDomainsForPackageCommand.ts index bd2625b9d987..9d02f560c833 100644 --- a/clients/client-opensearch/src/commands/ListDomainsForPackageCommand.ts +++ b/clients/client-opensearch/src/commands/ListDomainsForPackageCommand.ts @@ -86,7 +86,7 @@ export interface ListDomainsForPackageCommandOutput extends ListDomainsForPackag *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListInstanceTypeDetailsCommand.ts b/clients/client-opensearch/src/commands/ListInstanceTypeDetailsCommand.ts index 4a7258b1fc76..535e4a19b67a 100644 --- a/clients/client-opensearch/src/commands/ListInstanceTypeDetailsCommand.ts +++ b/clients/client-opensearch/src/commands/ListInstanceTypeDetailsCommand.ts @@ -45,6 +45,8 @@ export interface ListInstanceTypeDetailsCommandOutput extends ListInstanceTypeDe * DomainName: "STRING_VALUE", * MaxResults: Number("int"), * NextToken: "STRING_VALUE", + * RetrieveAZs: true || false, + * InstanceType: "STRING_VALUE", * }; * const command = new ListInstanceTypeDetailsCommand(input); * const response = await client.send(command); @@ -60,6 +62,9 @@ export interface ListInstanceTypeDetailsCommandOutput extends ListInstanceTypeDe * // InstanceRole: [ // InstanceRoleList * // "STRING_VALUE", * // ], + * // AvailabilityZones: [ // AvailabilityZoneList + * // "STRING_VALUE", + * // ], * // }, * // ], * // NextToken: "STRING_VALUE", @@ -80,7 +85,7 @@ export interface ListInstanceTypeDetailsCommandOutput extends ListInstanceTypeDe *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListPackagesForDomainCommand.ts b/clients/client-opensearch/src/commands/ListPackagesForDomainCommand.ts index 423dc2297e49..7b0bd144964c 100644 --- a/clients/client-opensearch/src/commands/ListPackagesForDomainCommand.ts +++ b/clients/client-opensearch/src/commands/ListPackagesForDomainCommand.ts @@ -86,7 +86,7 @@ export interface ListPackagesForDomainCommandOutput extends ListPackagesForDomai *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListScheduledActionsCommand.ts b/clients/client-opensearch/src/commands/ListScheduledActionsCommand.ts index db9451a5e7f0..c7042e1281a8 100644 --- a/clients/client-opensearch/src/commands/ListScheduledActionsCommand.ts +++ b/clients/client-opensearch/src/commands/ListScheduledActionsCommand.ts @@ -81,10 +81,10 @@ export interface ListScheduledActionsCommandOutput extends ListScheduledActionsR *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link InvalidPaginationTokenException} (client fault) - *

The request processing has failed because you provided an invalid pagination token.

+ *

Request processing failed because you provided an invalid pagination token.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListTagsCommand.ts b/clients/client-opensearch/src/commands/ListTagsCommand.ts index 8a33408237fc..ee7e2e0ace2f 100644 --- a/clients/client-opensearch/src/commands/ListTagsCommand.ts +++ b/clients/client-opensearch/src/commands/ListTagsCommand.ts @@ -69,7 +69,7 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListVersionsCommand.ts b/clients/client-opensearch/src/commands/ListVersionsCommand.ts index 1e4d1e72ea83..09bafff5e2e0 100644 --- a/clients/client-opensearch/src/commands/ListVersionsCommand.ts +++ b/clients/client-opensearch/src/commands/ListVersionsCommand.ts @@ -68,7 +68,7 @@ export interface ListVersionsCommandOutput extends ListVersionsResponse, __Metad *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/ListVpcEndpointAccessCommand.ts b/clients/client-opensearch/src/commands/ListVpcEndpointAccessCommand.ts index 2b2785b36e06..d8ff32f00be2 100644 --- a/clients/client-opensearch/src/commands/ListVpcEndpointAccessCommand.ts +++ b/clients/client-opensearch/src/commands/ListVpcEndpointAccessCommand.ts @@ -68,13 +68,13 @@ export interface ListVpcEndpointAccessCommandOutput extends ListVpcEndpointAcces *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/ListVpcEndpointsCommand.ts b/clients/client-opensearch/src/commands/ListVpcEndpointsCommand.ts index ee881c57b69f..0b103b3f91a2 100644 --- a/clients/client-opensearch/src/commands/ListVpcEndpointsCommand.ts +++ b/clients/client-opensearch/src/commands/ListVpcEndpointsCommand.ts @@ -68,7 +68,7 @@ export interface ListVpcEndpointsCommandOutput extends ListVpcEndpointsResponse, *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

diff --git a/clients/client-opensearch/src/commands/ListVpcEndpointsForDomainCommand.ts b/clients/client-opensearch/src/commands/ListVpcEndpointsForDomainCommand.ts index f7688a3509b9..2787940035f6 100644 --- a/clients/client-opensearch/src/commands/ListVpcEndpointsForDomainCommand.ts +++ b/clients/client-opensearch/src/commands/ListVpcEndpointsForDomainCommand.ts @@ -70,13 +70,13 @@ export interface ListVpcEndpointsForDomainCommandOutput extends ListVpcEndpoints *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/PurchaseReservedInstanceOfferingCommand.ts b/clients/client-opensearch/src/commands/PurchaseReservedInstanceOfferingCommand.ts index ff5bedbed430..65a04f5b110a 100644 --- a/clients/client-opensearch/src/commands/PurchaseReservedInstanceOfferingCommand.ts +++ b/clients/client-opensearch/src/commands/PurchaseReservedInstanceOfferingCommand.ts @@ -65,7 +65,7 @@ export interface PurchaseReservedInstanceOfferingCommandOutput * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

@@ -77,7 +77,7 @@ export interface PurchaseReservedInstanceOfferingCommandOutput *

An exception for creating a resource that already exists.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/RejectInboundConnectionCommand.ts b/clients/client-opensearch/src/commands/RejectInboundConnectionCommand.ts index e24550d1c81c..9a5df4fa5e96 100644 --- a/clients/client-opensearch/src/commands/RejectInboundConnectionCommand.ts +++ b/clients/client-opensearch/src/commands/RejectInboundConnectionCommand.ts @@ -79,10 +79,10 @@ export interface RejectInboundConnectionCommandOutput extends RejectInboundConne * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

diff --git a/clients/client-opensearch/src/commands/RevokeVpcEndpointAccessCommand.ts b/clients/client-opensearch/src/commands/RevokeVpcEndpointAccessCommand.ts index 8d47861df87b..422778cff71f 100644 --- a/clients/client-opensearch/src/commands/RevokeVpcEndpointAccessCommand.ts +++ b/clients/client-opensearch/src/commands/RevokeVpcEndpointAccessCommand.ts @@ -60,13 +60,13 @@ export interface RevokeVpcEndpointAccessCommandOutput extends RevokeVpcEndpointA *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/StartServiceSoftwareUpdateCommand.ts b/clients/client-opensearch/src/commands/StartServiceSoftwareUpdateCommand.ts index c9edfa2491b3..523cb02b2b6d 100644 --- a/clients/client-opensearch/src/commands/StartServiceSoftwareUpdateCommand.ts +++ b/clients/client-opensearch/src/commands/StartServiceSoftwareUpdateCommand.ts @@ -76,7 +76,7 @@ export interface StartServiceSoftwareUpdateCommandOutput extends StartServiceSof *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/UpdateDomainConfigCommand.ts b/clients/client-opensearch/src/commands/UpdateDomainConfigCommand.ts index f2e1d0365925..dc1c7838aac8 100644 --- a/clients/client-opensearch/src/commands/UpdateDomainConfigCommand.ts +++ b/clients/client-opensearch/src/commands/UpdateDomainConfigCommand.ts @@ -61,6 +61,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo * ColdStorageOptions: { // ColdStorageOptions * Enabled: true || false, // required * }, + * MultiAZWithStandbyEnabled: true || false, * }, * EBSOptions: { // EBSOptions * EBSEnabled: true || false, @@ -193,6 +194,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo * // ColdStorageOptions: { // ColdStorageOptions * // Enabled: true || false, // required * // }, + * // MultiAZWithStandbyEnabled: true || false, * // }, * // Status: { * // CreationDate: new Date("TIMESTAMP"), // required @@ -408,7 +410,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/UpdatePackageCommand.ts b/clients/client-opensearch/src/commands/UpdatePackageCommand.ts index 5811f37a713a..ff1cee72a218 100644 --- a/clients/client-opensearch/src/commands/UpdatePackageCommand.ts +++ b/clients/client-opensearch/src/commands/UpdatePackageCommand.ts @@ -89,7 +89,7 @@ export interface UpdatePackageCommandOutput extends UpdatePackageResponse, __Met *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/UpdateScheduledActionCommand.ts b/clients/client-opensearch/src/commands/UpdateScheduledActionCommand.ts index ddb43fa147a0..d9b26e61aa28 100644 --- a/clients/client-opensearch/src/commands/UpdateScheduledActionCommand.ts +++ b/clients/client-opensearch/src/commands/UpdateScheduledActionCommand.ts @@ -86,7 +86,7 @@ export interface UpdateScheduledActionCommandOutput extends UpdateScheduledActio *

An exception for trying to create more than the allowed number of resources or sub-resources.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link SlotNotAvailableException} (client fault) *

An exception for attempting to schedule a domain action during an unavailable time slot.

diff --git a/clients/client-opensearch/src/commands/UpdateVpcEndpointCommand.ts b/clients/client-opensearch/src/commands/UpdateVpcEndpointCommand.ts index 4dff67f6295e..790dbd5bd96a 100644 --- a/clients/client-opensearch/src/commands/UpdateVpcEndpointCommand.ts +++ b/clients/client-opensearch/src/commands/UpdateVpcEndpointCommand.ts @@ -89,13 +89,13 @@ export interface UpdateVpcEndpointCommandOutput extends UpdateVpcEndpointRespons *

An error occurred because the client attempts to remove a resource that is currently in use.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/UpgradeDomainCommand.ts b/clients/client-opensearch/src/commands/UpgradeDomainCommand.ts index f9b72c5c21bb..5014b32614c0 100644 --- a/clients/client-opensearch/src/commands/UpgradeDomainCommand.ts +++ b/clients/client-opensearch/src/commands/UpgradeDomainCommand.ts @@ -76,7 +76,7 @@ export interface UpgradeDomainCommandOutput extends UpgradeDomainResponse, __Met *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

@@ -85,7 +85,7 @@ export interface UpgradeDomainCommandOutput extends UpgradeDomainResponse, __Met *

An exception for creating a resource that already exists.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

diff --git a/clients/client-opensearch/src/commands/index.ts b/clients/client-opensearch/src/commands/index.ts index 3addb93ee585..74c64ac34fab 100644 --- a/clients/client-opensearch/src/commands/index.ts +++ b/clients/client-opensearch/src/commands/index.ts @@ -17,6 +17,7 @@ export * from "./DescribeDomainAutoTunesCommand"; export * from "./DescribeDomainChangeProgressCommand"; export * from "./DescribeDomainCommand"; export * from "./DescribeDomainConfigCommand"; +export * from "./DescribeDomainHealthCommand"; export * from "./DescribeDomainsCommand"; export * from "./DescribeDryRunProgressCommand"; export * from "./DescribeInboundConnectionsCommand"; diff --git a/clients/client-opensearch/src/models/models_0.ts b/clients/client-opensearch/src/models/models_0.ts index e8936aada71e..74d41659c71d 100644 --- a/clients/client-opensearch/src/models/models_0.ts +++ b/clients/client-opensearch/src/models/models_0.ts @@ -184,7 +184,7 @@ export interface AcceptInboundConnectionResponse { /** * @public - *

An error occured because the client wanted to access a not supported operation.

+ *

An error occured because the client wanted to access an unsupported operation.

*/ export class DisabledOperationException extends __BaseException { readonly name: "DisabledOperationException" = "DisabledOperationException"; @@ -224,7 +224,7 @@ export class LimitExceededException extends __BaseException { /** * @public - *

An exception for accessing or deleting a resource that does not exist..

+ *

An exception for accessing or deleting a resource that doesn't exist.

*/ export class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; @@ -852,8 +852,8 @@ export interface DomainPackageDetails { PackageVersion?: string; /** - *

Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same - * as synonym_path for dictionary files.

+ *

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path + * when the package is for synonym files.

*/ ReferencePath?: string; @@ -1331,7 +1331,7 @@ export interface ClusterConfig { DedicatedMasterType?: OpenSearchPartitionInstanceType | string; /** - *

Number of dedicated master nodes in the cluster. This number must be greater than 1, + *

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, * otherwise you receive a validation exception.

*/ DedicatedMasterCount?: number; @@ -1355,6 +1355,11 @@ export interface ClusterConfig { *

Container for cold storage configuration options.

*/ ColdStorageOptions?: ColdStorageOptions; + + /** + *

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

+ */ + MultiAZWithStandbyEnabled?: boolean; } /** @@ -1609,8 +1614,9 @@ export interface OffPeakWindow { export interface OffPeakWindowOptions { /** *

Whether to enable an off-peak window.

- *

This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. - * All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

+ *

This option is only available when modifying a domain created prior to February 16, 2023, + * not when creating a new domain. All domains created after this date have the off-peak window + * enabled by default. You can't disable the off-peak window after it's enabled for a domain.

*/ Enabled?: boolean; @@ -2298,7 +2304,7 @@ export interface CreatePackageRequest { PackageName: string | undefined; /** - *

Type of package.

+ *

The type of package.

*/ PackageType: PackageType | string | undefined; @@ -2344,7 +2350,7 @@ export interface PackageDetails { PackageID?: string; /** - *

User-specified name of the package.

+ *

The user-specified name of the package.

*/ PackageName?: string; @@ -2359,7 +2365,7 @@ export interface PackageDetails { PackageDescription?: string; /** - *

Current status of the package.

+ *

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

*/ PackageStatus?: PackageStatus | string; @@ -3350,6 +3356,248 @@ export interface DescribeDomainConfigResponse { DomainConfig: DomainConfig | undefined; } +/** + * @public + *

Container for the parameters to the DescribeDomainHealth operation.

+ */ +export interface DescribeDomainHealthRequest { + /** + *

The name of the domain.

+ */ + DomainName: string | undefined; +} + +/** + * @public + * @enum + */ +export const DomainHealth = { + Green: "Green", + NotAvailable: "NotAvailable", + Red: "Red", + Yellow: "Yellow", +} as const; + +/** + * @public + */ +export type DomainHealth = (typeof DomainHealth)[keyof typeof DomainHealth]; + +/** + * @public + * @enum + */ +export const DomainState = { + Active: "Active", + NotAvailable: "NotAvailable", + Processing: "Processing", +} as const; + +/** + * @public + */ +export type DomainState = (typeof DomainState)[keyof typeof DomainState]; + +/** + * @public + * @enum + */ +export const ZoneStatus = { + Active: "Active", + NotAvailable: "NotAvailable", + StandBy: "StandBy", +} as const; + +/** + * @public + */ +export type ZoneStatus = (typeof ZoneStatus)[keyof typeof ZoneStatus]; + +/** + * @public + *

Information about an Availability Zone on a domain.

+ */ +export interface AvailabilityZoneInfo { + /** + *

The name of the Availability Zone.

+ */ + AvailabilityZoneName?: string; + + /** + *

The current state of the Availability Zone. Current options are Active and StandBy.

+ *
    + *
  • + *

    + * Active - Data nodes in the Availability Zone are in use.

    + *
    • + *
  • + *

    + * StandBy - Data nodes in the Availability Zone are in a standby state.

    + *
    • + *
  • + *

    + * NotAvailable - Unable to retrieve information.

    + *
    • + *
+ */ + ZoneStatus?: ZoneStatus | string; + + /** + *

The total number of data nodes configured in the Availability Zone.

+ */ + ConfiguredDataNodeCount?: string; + + /** + *

The number of data nodes active in the Availability Zone.

+ */ + AvailableDataNodeCount?: string; + + /** + *

The total number of primary and replica shards in the Availability Zone.

+ */ + TotalShards?: string; + + /** + *

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

+ */ + TotalUnAssignedShards?: string; +} + +/** + * @public + *

Information about the active domain environment.

+ */ +export interface EnvironmentInfo { + /** + *

A list of AvailabilityZoneInfo for the domain.

+ */ + AvailabilityZoneInformation?: AvailabilityZoneInfo[]; +} + +/** + * @public + * @enum + */ +export const MasterNodeStatus = { + Available: "Available", + UnAvailable: "UnAvailable", +} as const; + +/** + * @public + */ +export type MasterNodeStatus = (typeof MasterNodeStatus)[keyof typeof MasterNodeStatus]; + +/** + * @public + *

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

+ */ +export interface DescribeDomainHealthResponse { + /** + *

The current state of the domain.

+ *
    + *
  • + *

    + * Processing - The domain has updates in progress.

    + *
    • + *
  • + *

    + * Active - Requested changes have been processed and deployed to the domain.

    + *
    • + *
+ */ + DomainState?: DomainState | string; + + /** + *

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

+ */ + AvailabilityZoneCount?: string; + + /** + *

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

+ */ + ActiveAvailabilityZoneCount?: string; + + /** + *

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

+ */ + StandByAvailabilityZoneCount?: string; + + /** + *

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

+ */ + DataNodeCount?: string; + + /** + *

A boolean that indicates if dedicated master nodes are activated for the domain.

+ */ + DedicatedMaster?: boolean; + + /** + *

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. + * If the service is unable to fetch this information, it will return NotAvailable.

+ */ + MasterEligibleNodeCount?: string; + + /** + *

The number of warm nodes configured for the domain.

+ */ + WarmNodeCount?: string; + + /** + *

Indicates whether the domain has an elected master node.

+ *
    + *
  • + *

    + * Available - The domain has an elected master node.

    + *
    • + *
  • + *

    + * UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

    + *
    • + *
+ */ + MasterNode?: MasterNodeStatus | string; + + /** + *

The current health status of your cluster.

+ *
    + *
  • + *

    + * Red - At least one primary shard is not allocated to any node.

    + *
    • + *
  • + *

    + * Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

    + *
    • + *
  • + *

    + * Green - All primary shards and their replicas are allocated to nodes.

    + *
    • + *
  • + *

    + * NotAvailable - Unable to retrieve cluster health.

    + *
    • + *
+ */ + ClusterHealth?: DomainHealth | string; + + /** + *

The total number of primary and replica shards for the domain.

+ */ + TotalShards?: string; + + /** + *

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

+ */ + TotalUnAssignedShards?: string; + + /** + *

A list of EnvironmentInfo for the domain.

+ */ + EnvironmentInformation?: EnvironmentInfo[]; +} + /** * @public *

Container for the parameters to the DescribeDomains operation.

@@ -3564,7 +3812,7 @@ export interface DescribeInboundConnectionsResponse { /** * @public - *

The request processing has failed because you provided an invalid pagination token.

+ *

Request processing failed because you provided an invalid pagination token.

*/ export class InvalidPaginationTokenException extends __BaseException { readonly name: "InvalidPaginationTokenException" = "InvalidPaginationTokenException"; @@ -4604,13 +4852,13 @@ export interface ListDomainsForPackageResponse { */ export interface ListInstanceTypeDetailsRequest { /** - *

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. + *

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. * Defaults to the latest version of OpenSearch.

*/ EngineVersion: string | undefined; /** - *

Name of the domain to list instance type details for.

+ *

The name of the domain.

*/ DomainName?: string; @@ -4626,6 +4874,16 @@ export interface ListInstanceTypeDetailsRequest { * ListInstanceTypeDetails operations, which returns results in the next page.

*/ NextToken?: string; + + /** + *

An optional parameter that specifies the Availability Zones for the domain.

+ */ + RetrieveAZs?: boolean; + + /** + *

An optional parameter that lists information for a given instance type.

+ */ + InstanceType?: string; } /** @@ -4670,6 +4928,11 @@ export interface InstanceTypeDetails { * node.

*/ InstanceRole?: string[]; + + /** + *

The supported Availability Zones for the instance type.

+ */ + AvailabilityZones?: string[]; } /** @@ -5244,13 +5507,6 @@ export interface UpdateDomainConfigRequest { * query. Default is 1,024. Queries with more than the permitted number of clauses result in a * TooManyClauses error.

* - *
  • - *

    - * "override_main_response_version": "true" | "false" - Note the use of a string - * rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow - * Elasticsearch OSS clients and plugins to continue working with it. Default is false when - * creating a domain and true when upgrading a domain.

    - *
    • * *

    For more information, see Advanced cluster parameters.

    */ diff --git a/clients/client-opensearch/src/protocols/Aws_restJson1.ts b/clients/client-opensearch/src/protocols/Aws_restJson1.ts index 189dcabd1355..7b54e7daf439 100644 --- a/clients/client-opensearch/src/protocols/Aws_restJson1.ts +++ b/clients/client-opensearch/src/protocols/Aws_restJson1.ts @@ -69,6 +69,10 @@ import { DescribeDomainConfigCommandInput, DescribeDomainConfigCommandOutput, } from "../commands/DescribeDomainConfigCommand"; +import { + DescribeDomainHealthCommandInput, + DescribeDomainHealthCommandOutput, +} from "../commands/DescribeDomainHealthCommand"; import { DescribeDomainsCommandInput, DescribeDomainsCommandOutput } from "../commands/DescribeDomainsCommand"; import { DescribeDryRunProgressCommandInput, @@ -796,6 +800,31 @@ export const se_DescribeDomainConfigCommand = async ( }); }; +/** + * serializeAws_restJson1DescribeDomainHealthCommand + */ +export const se_DescribeDomainHealthCommand = async ( + input: DescribeDomainHealthCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/health"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DescribeDomainsCommand */ @@ -1304,6 +1333,8 @@ export const se_ListInstanceTypeDetailsCommand = async ( domainName: [, input.DomainName!], maxResults: [() => input.MaxResults !== void 0, () => input.MaxResults!.toString()], nextToken: [, input.NextToken!], + retrieveAZs: [() => input.RetrieveAZs !== void 0, () => input.RetrieveAZs!.toString()], + instanceType: [, input.InstanceType!], }); let body: any; return new __HttpRequest({ @@ -2896,6 +2927,77 @@ const de_DescribeDomainConfigCommandError = async ( } }; +/** + * deserializeAws_restJson1DescribeDomainHealthCommand + */ +export const de_DescribeDomainHealthCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_DescribeDomainHealthCommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + ActiveAvailabilityZoneCount: __expectString, + AvailabilityZoneCount: __expectString, + ClusterHealth: __expectString, + DataNodeCount: __expectString, + DedicatedMaster: __expectBoolean, + DomainState: __expectString, + EnvironmentInformation: _json, + MasterEligibleNodeCount: __expectString, + MasterNode: __expectString, + StandByAvailabilityZoneCount: __expectString, + TotalShards: __expectString, + TotalUnAssignedShards: __expectString, + WarmNodeCount: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1DescribeDomainHealthCommandError + */ +const de_DescribeDomainHealthCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BaseException": + case "com.amazonaws.opensearch#BaseException": + throw await de_BaseExceptionRes(parsedOutput, context); + case "DisabledOperationException": + case "com.amazonaws.opensearch#DisabledOperationException": + throw await de_DisabledOperationExceptionRes(parsedOutput, context); + case "InternalException": + case "com.amazonaws.opensearch#InternalException": + throw await de_InternalExceptionRes(parsedOutput, context); + case "ResourceNotFoundException": + case "com.amazonaws.opensearch#ResourceNotFoundException": + throw await de_ResourceNotFoundExceptionRes(parsedOutput, context); + case "ValidationException": + case "com.amazonaws.opensearch#ValidationException": + throw await de_ValidationExceptionRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_restJson1DescribeDomainsCommand */ @@ -5361,6 +5463,12 @@ const de_AutoTuneStatus = (output: any, context: __SerdeContext): AutoTuneStatus }) as any; }; +// de_AvailabilityZoneInfo omitted. + +// de_AvailabilityZoneInfoList omitted. + +// de_AvailabilityZoneList omitted. + // de_AWSDomainInformation omitted. // de_ChangeProgressDetails omitted. @@ -5587,6 +5695,10 @@ const de_EncryptionAtRestOptionsStatus = (output: any, context: __SerdeContext): // de_EndpointsMap omitted. +// de_EnvironmentInfo omitted. + +// de_EnvironmentInfoList omitted. + // de_ErrorDetails omitted. // de_InboundConnection omitted. diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index 56ba45d30fc7..2428e0a1614c 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -528,6 +528,9 @@ { "target": "com.amazonaws.opensearch#DescribeDomainConfig" }, + { + "target": "com.amazonaws.opensearch#DescribeDomainHealth" + }, { "target": "com.amazonaws.opensearch#DescribeDomains" }, @@ -1009,8 +1012,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1022,8 +1025,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1035,8 +1038,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1048,8 +1051,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1061,8 +1064,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1074,8 +1077,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1087,8 +1090,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1100,8 +1103,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1113,8 +1116,8 @@ }, "params": { "Region": "ap-southeast-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1126,8 +1129,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1139,8 +1142,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1152,8 +1155,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1165,8 +1168,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1178,8 +1181,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1191,8 +1194,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1204,8 +1207,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1217,8 +1220,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1230,8 +1233,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1243,8 +1246,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1256,8 +1259,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1269,8 +1272,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1282,8 +1285,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1295,8 +1298,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1308,8 +1311,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1321,8 +1324,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1334,8 +1337,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1347,8 +1350,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1360,8 +1363,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1373,8 +1376,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1386,8 +1389,8 @@ }, "params": { "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1399,8 +1402,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1412,8 +1415,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1425,8 +1428,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1438,8 +1441,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1451,8 +1454,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1464,8 +1467,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1477,8 +1480,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1490,8 +1493,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1503,8 +1506,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1516,8 +1519,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1529,8 +1532,19 @@ }, "params": { "Region": "us-iso-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1542,8 +1556,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1555,8 +1580,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1568,8 +1604,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1581,8 +1628,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1594,8 +1641,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1606,8 +1653,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1618,10 +1665,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -2138,6 +2191,71 @@ "smithy.api#documentation": "

    Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

    " } }, + "com.amazonaws.opensearch#AvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.opensearch#AvailabilityZoneInfo": { + "type": "structure", + "members": { + "AvailabilityZoneName": { + "target": "com.amazonaws.opensearch#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

    The name of the Availability Zone.

    " + } + }, + "ZoneStatus": { + "target": "com.amazonaws.opensearch#ZoneStatus", + "traits": { + "smithy.api#documentation": "

    The current state of the Availability Zone. Current options are Active and StandBy.

    \n
      \n
    • \n

      \n Active - Data nodes in the Availability Zone are in use.

      \n
      • \n
    • \n

      \n StandBy - Data nodes in the Availability Zone are in a standby state.

      \n
      • \n
    • \n

      \n NotAvailable - Unable to retrieve information.

      \n
      • \n
    " + } + }, + "ConfiguredDataNodeCount": { + "target": "com.amazonaws.opensearch#NumberOfNodes", + "traits": { + "smithy.api#documentation": "

    The total number of data nodes configured in the Availability Zone.

    " + } + }, + "AvailableDataNodeCount": { + "target": "com.amazonaws.opensearch#NumberOfNodes", + "traits": { + "smithy.api#documentation": "

    The number of data nodes active in the Availability Zone.

    " + } + }, + "TotalShards": { + "target": "com.amazonaws.opensearch#NumberOfShards", + "traits": { + "smithy.api#documentation": "

    The total number of primary and replica shards in the Availability Zone.

    " + } + }, + "TotalUnAssignedShards": { + "target": "com.amazonaws.opensearch#NumberOfShards", + "traits": { + "smithy.api#documentation": "

    The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an Availability Zone on a domain.

    " + } + }, + "com.amazonaws.opensearch#AvailabilityZoneInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#AvailabilityZoneInfo" + } + }, + "com.amazonaws.opensearch#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#AvailabilityZone" + } + }, "com.amazonaws.opensearch#BackendRole": { "type": "string", "traits": { @@ -2419,7 +2537,7 @@ "DedicatedMasterCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { - "smithy.api#documentation": "

    Number of dedicated master nodes in the cluster. This number must be greater than 1,\n otherwise you receive a validation exception.

    " + "smithy.api#documentation": "

    Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4,\n otherwise you receive a validation exception.

    " } }, "WarmEnabled": { @@ -2445,6 +2563,12 @@ "traits": { "smithy.api#documentation": "

    Container for cold storage configuration options.

    " } + }, + "MultiAZWithStandbyEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

    A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

    " + } } }, "traits": { @@ -2993,7 +3117,7 @@ "PackageType": { "target": "com.amazonaws.opensearch#PackageType", "traits": { - "smithy.api#documentation": "

    Type of package.

    ", + "smithy.api#documentation": "

    The type of package.

    ", "smithy.api#required": {} } }, @@ -3721,6 +3845,144 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#DescribeDomainHealth": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DescribeDomainHealthRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DescribeDomainHealthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/health", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DescribeDomainHealthRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

    The name of the domain.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Container for the parameters to the DescribeDomainHealth operation.

    ", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#DescribeDomainHealthResponse": { + "type": "structure", + "members": { + "DomainState": { + "target": "com.amazonaws.opensearch#DomainState", + "traits": { + "smithy.api#documentation": "

    The current state of the domain.

    \n
      \n
    • \n

      \n Processing - The domain has updates in progress.

      \n
      • \n
    • \n

      \n Active - Requested changes have been processed and deployed to the domain.

      \n
      • \n
    " + } + }, + "AvailabilityZoneCount": { + "target": "com.amazonaws.opensearch#NumberOfAZs", + "traits": { + "smithy.api#documentation": "

    The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    " + } + }, + "ActiveAvailabilityZoneCount": { + "target": "com.amazonaws.opensearch#NumberOfAZs", + "traits": { + "smithy.api#documentation": "

    The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    " + } + }, + "StandByAvailabilityZoneCount": { + "target": "com.amazonaws.opensearch#NumberOfAZs", + "traits": { + "smithy.api#documentation": "

    The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    " + } + }, + "DataNodeCount": { + "target": "com.amazonaws.opensearch#NumberOfNodes", + "traits": { + "smithy.api#documentation": "

    The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

    " + } + }, + "DedicatedMaster": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

    A boolean that indicates if dedicated master nodes are activated for the domain.

    " + } + }, + "MasterEligibleNodeCount": { + "target": "com.amazonaws.opensearch#NumberOfNodes", + "traits": { + "smithy.api#documentation": "

    The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain.\n If the service is unable to fetch this information, it will return NotAvailable.

    " + } + }, + "WarmNodeCount": { + "target": "com.amazonaws.opensearch#NumberOfNodes", + "traits": { + "smithy.api#documentation": "

    The number of warm nodes configured for the domain.

    " + } + }, + "MasterNode": { + "target": "com.amazonaws.opensearch#MasterNodeStatus", + "traits": { + "smithy.api#documentation": "

    Indicates whether the domain has an elected master node.

    \n
      \n
    • \n

      \n Available - The domain has an elected master node.

      \n
      • \n
    • \n

      \n UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

      \n
      • \n
    " + } + }, + "ClusterHealth": { + "target": "com.amazonaws.opensearch#DomainHealth", + "traits": { + "smithy.api#documentation": "

    The current health status of your cluster.

    \n
      \n
    • \n

      \n Red - At least one primary shard is not allocated to any node.

      \n
      • \n
    • \n

      \n Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

      \n
      • \n
    • \n

      \n Green - All primary shards and their replicas are allocated to nodes.

      \n
      • \n
    • \n

      \n NotAvailable - Unable to retrieve cluster health.

      \n
      • \n
    " + } + }, + "TotalShards": { + "target": "com.amazonaws.opensearch#NumberOfShards", + "traits": { + "smithy.api#documentation": "

    The total number of primary and replica shards for the domain.

    " + } + }, + "TotalUnAssignedShards": { + "target": "com.amazonaws.opensearch#NumberOfShards", + "traits": { + "smithy.api#documentation": "

    The total number of primary and replica shards not allocated to any of the nodes for the cluster.

    " + } + }, + "EnvironmentInformation": { + "target": "com.amazonaws.opensearch#EnvironmentInfoList", + "traits": { + "smithy.api#documentation": "

    A list of EnvironmentInfo for the domain.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The result of a DescribeDomainHealth request. Contains health information for the requested domain.

    ", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#DescribeDomainRequest": { "type": "structure", "members": { @@ -4559,7 +4821,7 @@ } }, "traits": { - "smithy.api#documentation": "

    An error occured because the client wanted to access a not supported operation.

    ", + "smithy.api#documentation": "

    An error occured because the client wanted to access an unsupported operation.

    ", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -4821,6 +5083,35 @@ "smithy.api#documentation": "

    The configured endpoint options for a domain and their current status.

    " } }, + "com.amazonaws.opensearch#DomainHealth": { + "type": "enum", + "members": { + "Red": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Red" + } + }, + "Yellow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Yellow" + } + }, + "Green": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Green" + } + }, + "NotAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotAvailable" + } + } + } + }, "com.amazonaws.opensearch#DomainId": { "type": "string", "traits": { @@ -4952,7 +5243,7 @@ "ReferencePath": { "target": "com.amazonaws.opensearch#ReferencePath", "traits": { - "smithy.api#documentation": "

    Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same\n as synonym_path for dictionary files.

    " + "smithy.api#documentation": "

    The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path\n when the package is for synonym files.

    " } }, "ErrorDetails": { @@ -5007,6 +5298,29 @@ } } }, + "com.amazonaws.opensearch#DomainState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Processing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Processing" + } + }, + "NotAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotAvailable" + } + } + } + }, "com.amazonaws.opensearch#DomainStatus": { "type": "structure", "members": { @@ -5441,6 +5755,26 @@ } } }, + "com.amazonaws.opensearch#EnvironmentInfo": { + "type": "structure", + "members": { + "AvailabilityZoneInformation": { + "target": "com.amazonaws.opensearch#AvailabilityZoneInfoList", + "traits": { + "smithy.api#documentation": "

    A list of AvailabilityZoneInfo for the domain.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the active domain environment.

    " + } + }, + "com.amazonaws.opensearch#EnvironmentInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#EnvironmentInfo" + } + }, "com.amazonaws.opensearch#ErrorDetails": { "type": "structure", "members": { @@ -5594,7 +5928,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of Amazon OpenSearch Service package versions, along with their creation time\n and commit message. For more information, see Custom packages for Amazon\n OpenSearch Service.

    ", + "smithy.api#documentation": "

    Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the \n package is a zip plugin package). For more information, see Custom packages for Amazon\n OpenSearch Service.

    ", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/packages/{PackageID}/history", @@ -6062,6 +6396,12 @@ "traits": { "smithy.api#documentation": "

    Whether the instance acts as a data node, a dedicated master node, or an UltraWarm\n node.

    " } + }, + "AvailabilityZones": { + "target": "com.amazonaws.opensearch#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

    The supported Availability Zones for the instance type.

    " + } } }, "traits": { @@ -6074,6 +6414,16 @@ "target": "com.amazonaws.opensearch#InstanceTypeDetails" } }, + "com.amazonaws.opensearch#InstanceTypeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 40 + }, + "smithy.api#pattern": "^.*\\..*\\.search$" + } + }, "com.amazonaws.opensearch#Integer": { "type": "integer", "traits": { @@ -6110,7 +6460,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The request processing has failed because you provided an invalid pagination token.

    ", + "smithy.api#documentation": "

    Request processing failed because you provided an invalid pagination token.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6409,7 +6759,7 @@ "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { - "smithy.api#documentation": "

    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.\n Defaults to the latest version of OpenSearch.

    ", + "smithy.api#documentation": "

    The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.\n Defaults to the latest version of OpenSearch.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6417,7 +6767,7 @@ "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { - "smithy.api#documentation": "

    Name of the domain to list instance type details for.

    ", + "smithy.api#documentation": "

    The name of the domain.

    ", "smithy.api#httpQuery": "domainName" } }, @@ -6435,6 +6785,20 @@ "smithy.api#documentation": "

    If your initial ListInstanceTypeDetails operation returns a\n nextToken, you can include the returned nextToken in subsequent\n ListInstanceTypeDetails operations, which returns results in the next page.

    ", "smithy.api#httpQuery": "nextToken" } + }, + "RetrieveAZs": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the Availability Zones for the domain.

    ", + "smithy.api#httpQuery": "retrieveAZs" + } + }, + "InstanceType": { + "target": "com.amazonaws.opensearch#InstanceTypeString", + "traits": { + "smithy.api#documentation": "

    An optional parameter that lists information for a given instance type.

    ", + "smithy.api#httpQuery": "instanceType" + } } }, "traits": { @@ -7088,6 +7452,23 @@ "com.amazonaws.opensearch#Long": { "type": "long" }, + "com.amazonaws.opensearch#MasterNodeStatus": { + "type": "enum", + "members": { + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "UnAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnAvailable" + } + } + } + }, "com.amazonaws.opensearch#MasterUserOptions": { "type": "structure", "members": { @@ -7199,6 +7580,24 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]+$" } }, + "com.amazonaws.opensearch#NumberOfAZs": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" + } + }, + "com.amazonaws.opensearch#NumberOfNodes": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" + } + }, + "com.amazonaws.opensearch#NumberOfShards": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" + } + }, "com.amazonaws.opensearch#OffPeakWindow": { "type": "structure", "members": { @@ -7219,7 +7618,7 @@ "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

    Whether to enable an off-peak window.

    \n

    This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain.\n All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

    " + "smithy.api#documentation": "

    Whether to enable an off-peak window.

    \n

    This option is only available when modifying a domain created prior to February 16, 2023,\n not when creating a new domain. All domains created after this date have the off-peak window\n enabled by default. You can't disable the off-peak window after it's enabled for a domain.

    " } }, "OffPeakWindow": { @@ -8123,7 +8522,7 @@ "PackageName": { "target": "com.amazonaws.opensearch#PackageName", "traits": { - "smithy.api#documentation": "

    User-specified name of the package.

    " + "smithy.api#documentation": "

    The user-specified name of the package.

    " } }, "PackageType": { @@ -8141,7 +8540,7 @@ "PackageStatus": { "target": "com.amazonaws.opensearch#PackageStatus", "traits": { - "smithy.api#documentation": "

    Current status of the package.

    " + "smithy.api#documentation": "

    The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

    " } }, "CreatedAt": { @@ -8814,7 +9213,7 @@ } }, "traits": { - "smithy.api#documentation": "

    An exception for accessing or deleting a resource that does not exist..

    ", + "smithy.api#documentation": "

    An exception for accessing or deleting a resource that doesn't exist.

    ", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -9774,7 +10173,7 @@ "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { - "smithy.api#documentation": "

    Key-value pairs to specify advanced configuration options. The following key-value pairs are\n supported:

    \n
      \n
    • \n

      \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

      \n
      • \n
    • \n

      \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

      \n
      • \n
    • \n

      \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

      \n
      • \n
    • \n

      \n \"override_main_response_version\": \"true\" | \"false\" - Note the use of a string\n rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow\n Elasticsearch OSS clients and plugins to continue working with it. Default is false when\n creating a domain and true when upgrading a domain.

      \n
      • \n
    \n

    For more information, see Advanced cluster parameters.

    " + "smithy.api#documentation": "

    Key-value pairs to specify advanced configuration options. The following key-value pairs are\n supported:

    \n
      \n
    • \n

      \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

      \n
      • \n
    • \n

      \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

      \n
      • \n
    • \n

      \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

      \n
      • \n
    \n

    For more information, see Advanced cluster parameters.

    " } }, "AccessPolicies": { @@ -10844,6 +11243,29 @@ "traits": { "smithy.api#documentation": "

    The zone awareness configuration for an Amazon OpenSearch Service domain.

    " } + }, + "com.amazonaws.opensearch#ZoneStatus": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "StandBy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StandBy" + } + }, + "NotAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotAvailable" + } + } + } } } }