Skip to content

Commit fa13738

Browse files
author
awstools
committed
feat(client-elasticsearch-service): This release adds clear visibility to the customers on the changes that they make on the domain.
1 parent 39afff6 commit fa13738

16 files changed

+899
-4
lines changed

‎clients/client-elasticsearch-service/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,14 @@ AuthorizeVpcEndpointAccess
241241

242242
[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/)
243243

244+
</details>
245+
<details>
246+
<summary>
247+
CancelDomainConfigChange
248+
</summary>
249+
250+
[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/)
251+
244252
</details>
245253
<details>
246254
<summary>

‎clients/client-elasticsearch-service/src/ElasticsearchService.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ import {
1818
AuthorizeVpcEndpointAccessCommandInput,
1919
AuthorizeVpcEndpointAccessCommandOutput,
2020
} from "./commands/AuthorizeVpcEndpointAccessCommand";
21+
import {
22+
CancelDomainConfigChangeCommand,
23+
CancelDomainConfigChangeCommandInput,
24+
CancelDomainConfigChangeCommandOutput,
25+
} from "./commands/CancelDomainConfigChangeCommand";
2126
import {
2227
CancelElasticsearchServiceSoftwareUpdateCommand,
2328
CancelElasticsearchServiceSoftwareUpdateCommandInput,
@@ -247,6 +252,7 @@ const commands = {
247252
AddTagsCommand,
248253
AssociatePackageCommand,
249254
AuthorizeVpcEndpointAccessCommand,
255+
CancelDomainConfigChangeCommand,
250256
CancelElasticsearchServiceSoftwareUpdateCommand,
251257
CreateElasticsearchDomainCommand,
252258
CreateOutboundCrossClusterSearchConnectionCommand,
@@ -358,6 +364,23 @@ export interface ElasticsearchService {
358364
cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void
359365
): void;
360366

367+
/**
368+
* @see {@link CancelDomainConfigChangeCommand}
369+
*/
370+
cancelDomainConfigChange(
371+
args: CancelDomainConfigChangeCommandInput,
372+
options?: __HttpHandlerOptions
373+
): Promise<CancelDomainConfigChangeCommandOutput>;
374+
cancelDomainConfigChange(
375+
args: CancelDomainConfigChangeCommandInput,
376+
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
377+
): void;
378+
cancelDomainConfigChange(
379+
args: CancelDomainConfigChangeCommandInput,
380+
options: __HttpHandlerOptions,
381+
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
382+
): void;
383+
361384
/**
362385
* @see {@link CancelElasticsearchServiceSoftwareUpdateCommand}
363386
*/

‎clients/client-elasticsearch-service/src/ElasticsearchServiceClient.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ import {
5858
AuthorizeVpcEndpointAccessCommandInput,
5959
AuthorizeVpcEndpointAccessCommandOutput,
6060
} from "./commands/AuthorizeVpcEndpointAccessCommand";
61+
import {
62+
CancelDomainConfigChangeCommandInput,
63+
CancelDomainConfigChangeCommandOutput,
64+
} from "./commands/CancelDomainConfigChangeCommand";
6165
import {
6266
CancelElasticsearchServiceSoftwareUpdateCommandInput,
6367
CancelElasticsearchServiceSoftwareUpdateCommandOutput,
@@ -219,6 +223,7 @@ export type ServiceInputTypes =
219223
| AddTagsCommandInput
220224
| AssociatePackageCommandInput
221225
| AuthorizeVpcEndpointAccessCommandInput
226+
| CancelDomainConfigChangeCommandInput
222227
| CancelElasticsearchServiceSoftwareUpdateCommandInput
223228
| CreateElasticsearchDomainCommandInput
224229
| CreateOutboundCrossClusterSearchConnectionCommandInput
@@ -274,6 +279,7 @@ export type ServiceOutputTypes =
274279
| AddTagsCommandOutput
275280
| AssociatePackageCommandOutput
276281
| AuthorizeVpcEndpointAccessCommandOutput
282+
| CancelDomainConfigChangeCommandOutput
277283
| CancelElasticsearchServiceSoftwareUpdateCommandOutput
278284
| CreateElasticsearchDomainCommandOutput
279285
| CreateOutboundCrossClusterSearchConnectionCommandOutput

‎clients/client-elasticsearch-service/src/commands/CancelDomainConfigChangeCommand.ts‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import {
8+
ElasticsearchServiceClientResolvedConfig,
9+
ServiceInputTypes,
10+
ServiceOutputTypes,
11+
} from "../ElasticsearchServiceClient";
12+
import { commonParams } from "../endpoint/EndpointParameters";
13+
import { CancelDomainConfigChangeRequest, CancelDomainConfigChangeResponse } from "../models/models_0";
14+
import { de_CancelDomainConfigChangeCommand, se_CancelDomainConfigChangeCommand } from "../protocols/Aws_restJson1";
15+
16+
/**
17+
* @public
18+
*/
19+
export { __MetadataBearer, $Command };
20+
/**
21+
* @public
22+
*
23+
* The input for {@link CancelDomainConfigChangeCommand}.
24+
*/
25+
export interface CancelDomainConfigChangeCommandInput extends CancelDomainConfigChangeRequest {}
26+
/**
27+
* @public
28+
*
29+
* The output of {@link CancelDomainConfigChangeCommand}.
30+
*/
31+
export interface CancelDomainConfigChangeCommandOutput extends CancelDomainConfigChangeResponse, __MetadataBearer {}
32+
33+
/**
34+
* @public
35+
* <p>Cancels a pending configuration change on an Amazon OpenSearch Service domain.</p>
36+
* @example
37+
* Use a bare-bones client and the command you need to make an API call.
38+
* ```javascript
39+
* import { ElasticsearchServiceClient, CancelDomainConfigChangeCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import
40+
* // const { ElasticsearchServiceClient, CancelDomainConfigChangeCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import
41+
* const client = new ElasticsearchServiceClient(config);
42+
* const input = { // CancelDomainConfigChangeRequest
43+
* DomainName: "STRING_VALUE", // required
44+
* DryRun: true || false,
45+
* };
46+
* const command = new CancelDomainConfigChangeCommand(input);
47+
* const response = await client.send(command);
48+
* // { // CancelDomainConfigChangeResponse
49+
* // DryRun: true || false,
50+
* // CancelledChangeIds: [ // GUIDList
51+
* // "STRING_VALUE",
52+
* // ],
53+
* // CancelledChangeProperties: [ // CancelledChangePropertyList
54+
* // { // CancelledChangeProperty
55+
* // PropertyName: "STRING_VALUE",
56+
* // CancelledValue: "STRING_VALUE",
57+
* // ActiveValue: "STRING_VALUE",
58+
* // },
59+
* // ],
60+
* // };
61+
*
62+
* ```
63+
*
64+
* @param CancelDomainConfigChangeCommandInput - {@link CancelDomainConfigChangeCommandInput}
65+
* @returns {@link CancelDomainConfigChangeCommandOutput}
66+
* @see {@link CancelDomainConfigChangeCommandInput} for command's `input` shape.
67+
* @see {@link CancelDomainConfigChangeCommandOutput} for command's `response` shape.
68+
* @see {@link ElasticsearchServiceClientResolvedConfig | config} for ElasticsearchServiceClient's `config` shape.
69+
*
70+
* @throws {@link BaseException} (client fault)
71+
* <p>An error occurred while processing the request.</p>
72+
*
73+
* @throws {@link DisabledOperationException} (client fault)
74+
* <p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>
75+
*
76+
* @throws {@link InternalException} (server fault)
77+
* <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>
78+
*
79+
* @throws {@link ResourceNotFoundException} (client fault)
80+
* <p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>
81+
*
82+
* @throws {@link ValidationException} (client fault)
83+
* <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
84+
*
85+
* @throws {@link ElasticsearchServiceServiceException}
86+
* <p>Base exception class for all service exceptions from ElasticsearchService service.</p>
87+
*
88+
*/
89+
export class CancelDomainConfigChangeCommand extends $Command
90+
.classBuilder<
91+
CancelDomainConfigChangeCommandInput,
92+
CancelDomainConfigChangeCommandOutput,
93+
ElasticsearchServiceClientResolvedConfig,
94+
ServiceInputTypes,
95+
ServiceOutputTypes
96+
>()
97+
.ep({
98+
...commonParams,
99+
})
100+
.m(function (this: any, Command: any, cs: any, config: ElasticsearchServiceClientResolvedConfig, o: any) {
101+
return [
102+
getSerdePlugin(config, this.serialize, this.deserialize),
103+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
104+
];
105+
})
106+
.s("AmazonElasticsearchService2015", "CancelDomainConfigChange", {})
107+
.n("ElasticsearchServiceClient", "CancelDomainConfigChangeCommand")
108+
.f(void 0, void 0)
109+
.ser(se_CancelDomainConfigChangeCommand)
110+
.de(de_CancelDomainConfigChangeCommand)
111+
.build() {}

‎clients/client-elasticsearch-service/src/commands/CreateElasticsearchDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,20 @@ export interface CreateElasticsearchDomainCommandOutput extends CreateElasticsea
272272
* // ChangeProgressDetails: { // ChangeProgressDetails
273273
* // ChangeId: "STRING_VALUE",
274274
* // Message: "STRING_VALUE",
275+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
276+
* // StartTime: new Date("TIMESTAMP"),
277+
* // LastUpdatedTime: new Date("TIMESTAMP"),
278+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
275279
* // },
280+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
281+
* // ModifyingProperties: [ // ModifyingPropertiesList
282+
* // { // ModifyingProperties
283+
* // Name: "STRING_VALUE",
284+
* // ActiveValue: "STRING_VALUE",
285+
* // PendingValue: "STRING_VALUE",
286+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
287+
* // },
288+
* // ],
276289
* // },
277290
* // };
278291
*

‎clients/client-elasticsearch-service/src/commands/DeleteElasticsearchDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,20 @@ export interface DeleteElasticsearchDomainCommandOutput extends DeleteElasticsea
160160
* // ChangeProgressDetails: { // ChangeProgressDetails
161161
* // ChangeId: "STRING_VALUE",
162162
* // Message: "STRING_VALUE",
163+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
164+
* // StartTime: new Date("TIMESTAMP"),
165+
* // LastUpdatedTime: new Date("TIMESTAMP"),
166+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
163167
* // },
168+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
169+
* // ModifyingProperties: [ // ModifyingPropertiesList
170+
* // { // ModifyingProperties
171+
* // Name: "STRING_VALUE",
172+
* // ActiveValue: "STRING_VALUE",
173+
* // PendingValue: "STRING_VALUE",
174+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
175+
* // },
176+
* // ],
164177
* // },
165178
* // };
166179
*

‎clients/client-elasticsearch-service/src/commands/DescribeDomainChangeProgressCommand.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ export interface DescribeDomainChangeProgressCommandOutput
7171
* // LastUpdated: new Date("TIMESTAMP"),
7272
* // },
7373
* // ],
74+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
75+
* // LastUpdatedTime: new Date("TIMESTAMP"),
76+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
7477
* // },
7578
* // };
7679
*

‎clients/client-elasticsearch-service/src/commands/DescribeElasticsearchDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,20 @@ export interface DescribeElasticsearchDomainCommandOutput
165165
* // ChangeProgressDetails: { // ChangeProgressDetails
166166
* // ChangeId: "STRING_VALUE",
167167
* // Message: "STRING_VALUE",
168+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
169+
* // StartTime: new Date("TIMESTAMP"),
170+
* // LastUpdatedTime: new Date("TIMESTAMP"),
171+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
168172
* // },
173+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
174+
* // ModifyingProperties: [ // ModifyingPropertiesList
175+
* // { // ModifyingProperties
176+
* // Name: "STRING_VALUE",
177+
* // ActiveValue: "STRING_VALUE",
178+
* // PendingValue: "STRING_VALUE",
179+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
180+
* // },
181+
* // ],
169182
* // },
170183
* // };
171184
*

‎clients/client-elasticsearch-service/src/commands/DescribeElasticsearchDomainConfigCommand.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,19 @@ export interface DescribeElasticsearchDomainConfigCommandOutput
236236
* // ChangeProgressDetails: { // ChangeProgressDetails
237237
* // ChangeId: "STRING_VALUE",
238238
* // Message: "STRING_VALUE",
239+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
240+
* // StartTime: new Date("TIMESTAMP"),
241+
* // LastUpdatedTime: new Date("TIMESTAMP"),
242+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
239243
* // },
244+
* // ModifyingProperties: [ // ModifyingPropertiesList
245+
* // { // ModifyingProperties
246+
* // Name: "STRING_VALUE",
247+
* // ActiveValue: "STRING_VALUE",
248+
* // PendingValue: "STRING_VALUE",
249+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
250+
* // },
251+
* // ],
240252
* // },
241253
* // };
242254
*

‎clients/client-elasticsearch-service/src/commands/DescribeElasticsearchDomainsCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,20 @@ export interface DescribeElasticsearchDomainsCommandOutput
168168
* // ChangeProgressDetails: { // ChangeProgressDetails
169169
* // ChangeId: "STRING_VALUE",
170170
* // Message: "STRING_VALUE",
171+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
172+
* // StartTime: new Date("TIMESTAMP"),
173+
* // LastUpdatedTime: new Date("TIMESTAMP"),
174+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
171175
* // },
176+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
177+
* // ModifyingProperties: [ // ModifyingPropertiesList
178+
* // { // ModifyingProperties
179+
* // Name: "STRING_VALUE",
180+
* // ActiveValue: "STRING_VALUE",
181+
* // PendingValue: "STRING_VALUE",
182+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
183+
* // },
184+
* // ],
172185
* // },
173186
* // ],
174187
* // };

0 commit comments

Comments
 (0)