Skip to content

Commit

Permalink
feat(client-elasticsearch-service): This release adds clear visibilit…
Browse files Browse the repository at this point in the history
…y to the customers on the changes that they make on the domain.
  • Loading branch information
awstools committed Feb 6, 2024
1 parent 39afff6 commit fa13738
Show file tree
Hide file tree
Showing 16 changed files with 899 additions and 4 deletions.
8 changes: 8 additions & 0 deletions clients/client-elasticsearch-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,14 @@ AuthorizeVpcEndpointAccess

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elasticsearch-service/command/AuthorizeVpcEndpointAccessCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-elasticsearch-service/Interface/AuthorizeVpcEndpointAccessCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-elasticsearch-service/Interface/AuthorizeVpcEndpointAccessCommandOutput/)

</details>
<details>
<summary>
CancelDomainConfigChange
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elasticsearch-service/command/CancelDomainConfigChangeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-elasticsearch-service/Interface/CancelDomainConfigChangeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-elasticsearch-service/Interface/CancelDomainConfigChangeCommandOutput/)

</details>
<details>
<summary>
Expand Down
23 changes: 23 additions & 0 deletions clients/client-elasticsearch-service/src/ElasticsearchService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ import {
AuthorizeVpcEndpointAccessCommandInput,
AuthorizeVpcEndpointAccessCommandOutput,
} from "./commands/AuthorizeVpcEndpointAccessCommand";
import {
CancelDomainConfigChangeCommand,
CancelDomainConfigChangeCommandInput,
CancelDomainConfigChangeCommandOutput,
} from "./commands/CancelDomainConfigChangeCommand";
import {
CancelElasticsearchServiceSoftwareUpdateCommand,
CancelElasticsearchServiceSoftwareUpdateCommandInput,
Expand Down Expand Up @@ -247,6 +252,7 @@ const commands = {
AddTagsCommand,
AssociatePackageCommand,
AuthorizeVpcEndpointAccessCommand,
CancelDomainConfigChangeCommand,
CancelElasticsearchServiceSoftwareUpdateCommand,
CreateElasticsearchDomainCommand,
CreateOutboundCrossClusterSearchConnectionCommand,
Expand Down Expand Up @@ -358,6 +364,23 @@ export interface ElasticsearchService {
cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void
): void;

/**
* @see {@link CancelDomainConfigChangeCommand}
*/
cancelDomainConfigChange(
args: CancelDomainConfigChangeCommandInput,
options?: __HttpHandlerOptions
): Promise<CancelDomainConfigChangeCommandOutput>;
cancelDomainConfigChange(
args: CancelDomainConfigChangeCommandInput,
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
): void;
cancelDomainConfigChange(
args: CancelDomainConfigChangeCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
): void;

/**
* @see {@link CancelElasticsearchServiceSoftwareUpdateCommand}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ import {
AuthorizeVpcEndpointAccessCommandInput,
AuthorizeVpcEndpointAccessCommandOutput,
} from "./commands/AuthorizeVpcEndpointAccessCommand";
import {
CancelDomainConfigChangeCommandInput,
CancelDomainConfigChangeCommandOutput,
} from "./commands/CancelDomainConfigChangeCommand";
import {
CancelElasticsearchServiceSoftwareUpdateCommandInput,
CancelElasticsearchServiceSoftwareUpdateCommandOutput,
Expand Down Expand Up @@ -219,6 +223,7 @@ export type ServiceInputTypes =
| AddTagsCommandInput
| AssociatePackageCommandInput
| AuthorizeVpcEndpointAccessCommandInput
| CancelDomainConfigChangeCommandInput
| CancelElasticsearchServiceSoftwareUpdateCommandInput
| CreateElasticsearchDomainCommandInput
| CreateOutboundCrossClusterSearchConnectionCommandInput
Expand Down Expand Up @@ -274,6 +279,7 @@ export type ServiceOutputTypes =
| AddTagsCommandOutput
| AssociatePackageCommandOutput
| AuthorizeVpcEndpointAccessCommandOutput
| CancelDomainConfigChangeCommandOutput
| CancelElasticsearchServiceSoftwareUpdateCommandOutput
| CreateElasticsearchDomainCommandOutput
| CreateOutboundCrossClusterSearchConnectionCommandOutput
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import {
ElasticsearchServiceClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes,
} from "../ElasticsearchServiceClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { CancelDomainConfigChangeRequest, CancelDomainConfigChangeResponse } from "../models/models_0";
import { de_CancelDomainConfigChangeCommand, se_CancelDomainConfigChangeCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link CancelDomainConfigChangeCommand}.
*/
export interface CancelDomainConfigChangeCommandInput extends CancelDomainConfigChangeRequest {}
/**
* @public
*
* The output of {@link CancelDomainConfigChangeCommand}.
*/
export interface CancelDomainConfigChangeCommandOutput extends CancelDomainConfigChangeResponse, __MetadataBearer {}

/**
* @public
* <p>Cancels a pending configuration change on an Amazon OpenSearch Service domain.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { ElasticsearchServiceClient, CancelDomainConfigChangeCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import
* // const { ElasticsearchServiceClient, CancelDomainConfigChangeCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import
* const client = new ElasticsearchServiceClient(config);
* const input = { // CancelDomainConfigChangeRequest
* DomainName: "STRING_VALUE", // required
* DryRun: true || false,
* };
* const command = new CancelDomainConfigChangeCommand(input);
* const response = await client.send(command);
* // { // CancelDomainConfigChangeResponse
* // DryRun: true || false,
* // CancelledChangeIds: [ // GUIDList
* // "STRING_VALUE",
* // ],
* // CancelledChangeProperties: [ // CancelledChangePropertyList
* // { // CancelledChangeProperty
* // PropertyName: "STRING_VALUE",
* // CancelledValue: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // },
* // ],
* // };
*
* ```
*
* @param CancelDomainConfigChangeCommandInput - {@link CancelDomainConfigChangeCommandInput}
* @returns {@link CancelDomainConfigChangeCommandOutput}
* @see {@link CancelDomainConfigChangeCommandInput} for command's `input` shape.
* @see {@link CancelDomainConfigChangeCommandOutput} for command's `response` shape.
* @see {@link ElasticsearchServiceClientResolvedConfig | config} for ElasticsearchServiceClient's `config` shape.
*
* @throws {@link BaseException} (client fault)
* <p>An error occurred while processing the request.</p>
*
* @throws {@link DisabledOperationException} (client fault)
* <p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>
*
* @throws {@link InternalException} (server fault)
* <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
*
* @throws {@link ElasticsearchServiceServiceException}
* <p>Base exception class for all service exceptions from ElasticsearchService service.</p>
*
*/
export class CancelDomainConfigChangeCommand extends $Command
.classBuilder<
CancelDomainConfigChangeCommandInput,
CancelDomainConfigChangeCommandOutput,
ElasticsearchServiceClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: ElasticsearchServiceClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("AmazonElasticsearchService2015", "CancelDomainConfigChange", {})
.n("ElasticsearchServiceClient", "CancelDomainConfigChangeCommand")
.f(void 0, void 0)
.ser(se_CancelDomainConfigChangeCommand)
.de(de_CancelDomainConfigChangeCommand)
.build() {}
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,20 @@ export interface CreateElasticsearchDomainCommandOutput extends CreateElasticsea
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,20 @@ export interface DeleteElasticsearchDomainCommandOutput extends DeleteElasticsea
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ export interface DescribeDomainChangeProgressCommandOutput
* // LastUpdated: new Date("TIMESTAMP"),
* // },
* // ],
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,20 @@ export interface DescribeElasticsearchDomainCommandOutput
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,19 @@ export interface DescribeElasticsearchDomainConfigCommandOutput
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,20 @@ export interface DescribeElasticsearchDomainsCommandOutput
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // ],
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,19 @@ export interface UpdateElasticsearchDomainConfigCommandOutput
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // ModifyingProperties: [ // ModifyingPropertiesList
* // { // ModifyingProperties
* // Name: "STRING_VALUE",
* // ActiveValue: "STRING_VALUE",
* // PendingValue: "STRING_VALUE",
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
* // },
* // ],
* // },
* // DryRunResults: { // DryRunResults
* // DeploymentType: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ export interface UpgradeElasticsearchDomainCommandOutput extends UpgradeElastics
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
* // StartTime: new Date("TIMESTAMP"),
* // LastUpdatedTime: new Date("TIMESTAMP"),
* // InitiatedBy: "CUSTOMER" || "SERVICE",
* // },
* // };
*
Expand Down
1 change: 1 addition & 0 deletions clients/client-elasticsearch-service/src/commands/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ export * from "./AcceptInboundCrossClusterSearchConnectionCommand";
export * from "./AddTagsCommand";
export * from "./AssociatePackageCommand";
export * from "./AuthorizeVpcEndpointAccessCommand";
export * from "./CancelDomainConfigChangeCommand";
export * from "./CancelElasticsearchServiceSoftwareUpdateCommand";
export * from "./CreateElasticsearchDomainCommand";
export * from "./CreateOutboundCrossClusterSearchConnectionCommand";
Expand Down
Loading

0 comments on commit fa13738

Please sign in to comment.