Skip to content

Commit 39afff6

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

17 files changed

+914
-7
lines changed

‎clients/client-opensearch/README.md‎

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

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

254+
</details>
255+
<details>
256+
<summary>
257+
CancelDomainConfigChange
258+
</summary>
259+
260+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opensearch/command/CancelDomainConfigChangeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CancelDomainConfigChangeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opensearch/Interface/CancelDomainConfigChangeCommandOutput/)
261+
254262
</details>
255263
<details>
256264
<summary>

‎clients/client-opensearch/src/OpenSearch.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ import {
2323
AuthorizeVpcEndpointAccessCommandInput,
2424
AuthorizeVpcEndpointAccessCommandOutput,
2525
} from "./commands/AuthorizeVpcEndpointAccessCommand";
26+
import {
27+
CancelDomainConfigChangeCommand,
28+
CancelDomainConfigChangeCommandInput,
29+
CancelDomainConfigChangeCommandOutput,
30+
} from "./commands/CancelDomainConfigChangeCommand";
2631
import {
2732
CancelServiceSoftwareUpdateCommand,
2833
CancelServiceSoftwareUpdateCommandInput,
@@ -308,6 +313,7 @@ const commands = {
308313
AddTagsCommand,
309314
AssociatePackageCommand,
310315
AuthorizeVpcEndpointAccessCommand,
316+
CancelDomainConfigChangeCommand,
311317
CancelServiceSoftwareUpdateCommand,
312318
CreateDomainCommand,
313319
CreateOutboundConnectionCommand,
@@ -441,6 +447,23 @@ export interface OpenSearch {
441447
cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void
442448
): void;
443449

450+
/**
451+
* @see {@link CancelDomainConfigChangeCommand}
452+
*/
453+
cancelDomainConfigChange(
454+
args: CancelDomainConfigChangeCommandInput,
455+
options?: __HttpHandlerOptions
456+
): Promise<CancelDomainConfigChangeCommandOutput>;
457+
cancelDomainConfigChange(
458+
args: CancelDomainConfigChangeCommandInput,
459+
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
460+
): void;
461+
cancelDomainConfigChange(
462+
args: CancelDomainConfigChangeCommandInput,
463+
options: __HttpHandlerOptions,
464+
cb: (err: any, data?: CancelDomainConfigChangeCommandOutput) => void
465+
): void;
466+
444467
/**
445468
* @see {@link CancelServiceSoftwareUpdateCommand}
446469
*/

‎clients/client-opensearch/src/OpenSearchClient.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ import {
5959
AuthorizeVpcEndpointAccessCommandInput,
6060
AuthorizeVpcEndpointAccessCommandOutput,
6161
} from "./commands/AuthorizeVpcEndpointAccessCommand";
62+
import {
63+
CancelDomainConfigChangeCommandInput,
64+
CancelDomainConfigChangeCommandOutput,
65+
} from "./commands/CancelDomainConfigChangeCommand";
6266
import {
6367
CancelServiceSoftwareUpdateCommandInput,
6468
CancelServiceSoftwareUpdateCommandOutput,
@@ -232,6 +236,7 @@ export type ServiceInputTypes =
232236
| AddTagsCommandInput
233237
| AssociatePackageCommandInput
234238
| AuthorizeVpcEndpointAccessCommandInput
239+
| CancelDomainConfigChangeCommandInput
235240
| CancelServiceSoftwareUpdateCommandInput
236241
| CreateDomainCommandInput
237242
| CreateOutboundConnectionCommandInput
@@ -299,6 +304,7 @@ export type ServiceOutputTypes =
299304
| AddTagsCommandOutput
300305
| AssociatePackageCommandOutput
301306
| AuthorizeVpcEndpointAccessCommandOutput
307+
| CancelDomainConfigChangeCommandOutput
302308
| CancelServiceSoftwareUpdateCommandOutput
303309
| CreateDomainCommandOutput
304310
| CreateOutboundConnectionCommandOutput

‎clients/client-opensearch/src/commands/CancelDomainConfigChangeCommand.ts‎

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

‎clients/client-opensearch/src/commands/CreateDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,10 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
282282
* // ChangeProgressDetails: { // ChangeProgressDetails
283283
* // ChangeId: "STRING_VALUE",
284284
* // Message: "STRING_VALUE",
285+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
286+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
287+
* // StartTime: new Date("TIMESTAMP"),
288+
* // LastUpdatedTime: new Date("TIMESTAMP"),
285289
* // },
286290
* // OffPeakWindowOptions: { // OffPeakWindowOptions
287291
* // Enabled: true || false,
@@ -295,6 +299,15 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
295299
* // SoftwareUpdateOptions: { // SoftwareUpdateOptions
296300
* // AutoSoftwareUpdateEnabled: true || false,
297301
* // },
302+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
303+
* // ModifyingProperties: [ // ModifyingPropertiesList
304+
* // { // ModifyingProperties
305+
* // Name: "STRING_VALUE",
306+
* // ActiveValue: "STRING_VALUE",
307+
* // PendingValue: "STRING_VALUE",
308+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
309+
* // },
310+
* // ],
298311
* // },
299312
* // };
300313
*

‎clients/client-opensearch/src/commands/DeleteDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,10 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
161161
* // ChangeProgressDetails: { // ChangeProgressDetails
162162
* // ChangeId: "STRING_VALUE",
163163
* // Message: "STRING_VALUE",
164+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
165+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
166+
* // StartTime: new Date("TIMESTAMP"),
167+
* // LastUpdatedTime: new Date("TIMESTAMP"),
164168
* // },
165169
* // OffPeakWindowOptions: { // OffPeakWindowOptions
166170
* // Enabled: true || false,
@@ -174,6 +178,15 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
174178
* // SoftwareUpdateOptions: { // SoftwareUpdateOptions
175179
* // AutoSoftwareUpdateEnabled: true || false,
176180
* // },
181+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
182+
* // ModifyingProperties: [ // ModifyingPropertiesList
183+
* // { // ModifyingProperties
184+
* // Name: "STRING_VALUE",
185+
* // ActiveValue: "STRING_VALUE",
186+
* // PendingValue: "STRING_VALUE",
187+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
188+
* // },
189+
* // ],
177190
* // },
178191
* // };
179192
*

‎clients/client-opensearch/src/commands/DescribeDomainChangeProgressCommand.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ export interface DescribeDomainChangeProgressCommandOutput
6767
* // LastUpdated: new Date("TIMESTAMP"),
6868
* // },
6969
* // ],
70+
* // LastUpdatedTime: new Date("TIMESTAMP"),
71+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
72+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
7073
* // },
7174
* // };
7275
*

‎clients/client-opensearch/src/commands/DescribeDomainCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,10 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
161161
* // ChangeProgressDetails: { // ChangeProgressDetails
162162
* // ChangeId: "STRING_VALUE",
163163
* // Message: "STRING_VALUE",
164+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
165+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
166+
* // StartTime: new Date("TIMESTAMP"),
167+
* // LastUpdatedTime: new Date("TIMESTAMP"),
164168
* // },
165169
* // OffPeakWindowOptions: { // OffPeakWindowOptions
166170
* // Enabled: true || false,
@@ -174,6 +178,15 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
174178
* // SoftwareUpdateOptions: { // SoftwareUpdateOptions
175179
* // AutoSoftwareUpdateEnabled: true || false,
176180
* // },
181+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
182+
* // ModifyingProperties: [ // ModifyingPropertiesList
183+
* // { // ModifyingProperties
184+
* // Name: "STRING_VALUE",
185+
* // ActiveValue: "STRING_VALUE",
186+
* // PendingValue: "STRING_VALUE",
187+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
188+
* // },
189+
* // ],
177190
* // },
178191
* // };
179192
*

‎clients/client-opensearch/src/commands/DescribeDomainConfigCommand.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,10 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
230230
* // ChangeProgressDetails: { // ChangeProgressDetails
231231
* // ChangeId: "STRING_VALUE",
232232
* // Message: "STRING_VALUE",
233+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
234+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
235+
* // StartTime: new Date("TIMESTAMP"),
236+
* // LastUpdatedTime: new Date("TIMESTAMP"),
233237
* // },
234238
* // OffPeakWindowOptions: { // OffPeakWindowOptionsStatus
235239
* // Options: { // OffPeakWindowOptions
@@ -249,6 +253,14 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
249253
* // },
250254
* // Status: "<OptionStatus>",
251255
* // },
256+
* // ModifyingProperties: [ // ModifyingPropertiesList
257+
* // { // ModifyingProperties
258+
* // Name: "STRING_VALUE",
259+
* // ActiveValue: "STRING_VALUE",
260+
* // PendingValue: "STRING_VALUE",
261+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
262+
* // },
263+
* // ],
252264
* // },
253265
* // };
254266
*

‎clients/client-opensearch/src/commands/DescribeDomainsCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
164164
* // ChangeProgressDetails: { // ChangeProgressDetails
165165
* // ChangeId: "STRING_VALUE",
166166
* // Message: "STRING_VALUE",
167+
* // ConfigChangeStatus: "Pending" || "Initializing" || "Validating" || "ValidationFailed" || "ApplyingChanges" || "Completed" || "PendingUserInput" || "Cancelled",
168+
* // InitiatedBy: "CUSTOMER" || "SERVICE",
169+
* // StartTime: new Date("TIMESTAMP"),
170+
* // LastUpdatedTime: new Date("TIMESTAMP"),
167171
* // },
168172
* // OffPeakWindowOptions: { // OffPeakWindowOptions
169173
* // Enabled: true || false,
@@ -177,6 +181,15 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
177181
* // SoftwareUpdateOptions: { // SoftwareUpdateOptions
178182
* // AutoSoftwareUpdateEnabled: true || false,
179183
* // },
184+
* // DomainProcessingStatus: "Creating" || "Active" || "Modifying" || "UpgradingEngineVersion" || "UpdatingServiceSoftware" || "Isolated" || "Deleting",
185+
* // ModifyingProperties: [ // ModifyingPropertiesList
186+
* // { // ModifyingProperties
187+
* // Name: "STRING_VALUE",
188+
* // ActiveValue: "STRING_VALUE",
189+
* // PendingValue: "STRING_VALUE",
190+
* // ValueType: "PLAIN_TEXT" || "STRINGIFIED_JSON",
191+
* // },
192+
* // ],
180193
* // },
181194
* // ],
182195
* // };

0 commit comments

Comments
 (0)