/
DescribeDomainConfigCommand.ts
354 lines (343 loc) · 18.2 KB
/
DescribeDomainConfigCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
// 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 { DescribeDomainConfigRequest, DescribeDomainConfigResponse } from "../models/models_0";
import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
import { de_DescribeDomainConfigCommand, se_DescribeDomainConfigCommand } from "../protocols/Aws_restJson1";
/**
* @public
*
* The input for {@link DescribeDomainConfigCommand}.
*/
export interface DescribeDomainConfigCommandInput extends DescribeDomainConfigRequest {}
/**
* @public
*
* The output of {@link DescribeDomainConfigCommand}.
*/
export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigResponse, __MetadataBearer {}
/**
* @public
* <p>Returns the configuration of an Amazon OpenSearch Service domain.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { OpenSearchClient, DescribeDomainConfigCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
* // const { OpenSearchClient, DescribeDomainConfigCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
* const client = new OpenSearchClient(config);
* const input = { // DescribeDomainConfigRequest
* DomainName: "STRING_VALUE", // required
* };
* const command = new DescribeDomainConfigCommand(input);
* const response = await client.send(command);
* // { // DescribeDomainConfigResponse
* // DomainConfig: { // DomainConfig
* // EngineVersion: { // VersionStatus
* // Options: "STRING_VALUE", // required
* // Status: { // OptionStatus
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "RequiresIndexDocuments" || "Processing" || "Active", // required
* // PendingDeletion: true || false,
* // },
* // },
* // ClusterConfig: { // ClusterConfigStatus
* // Options: { // ClusterConfig
* // InstanceType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
* // InstanceCount: Number("int"),
* // DedicatedMasterEnabled: true || false,
* // ZoneAwarenessEnabled: true || false,
* // ZoneAwarenessConfig: { // ZoneAwarenessConfig
* // AvailabilityZoneCount: Number("int"),
* // },
* // DedicatedMasterType: "m3.medium.search" || "m3.large.search" || "m3.xlarge.search" || "m3.2xlarge.search" || "m4.large.search" || "m4.xlarge.search" || "m4.2xlarge.search" || "m4.4xlarge.search" || "m4.10xlarge.search" || "m5.large.search" || "m5.xlarge.search" || "m5.2xlarge.search" || "m5.4xlarge.search" || "m5.12xlarge.search" || "m5.24xlarge.search" || "r5.large.search" || "r5.xlarge.search" || "r5.2xlarge.search" || "r5.4xlarge.search" || "r5.12xlarge.search" || "r5.24xlarge.search" || "c5.large.search" || "c5.xlarge.search" || "c5.2xlarge.search" || "c5.4xlarge.search" || "c5.9xlarge.search" || "c5.18xlarge.search" || "t3.nano.search" || "t3.micro.search" || "t3.small.search" || "t3.medium.search" || "t3.large.search" || "t3.xlarge.search" || "t3.2xlarge.search" || "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search" || "t2.micro.search" || "t2.small.search" || "t2.medium.search" || "r3.large.search" || "r3.xlarge.search" || "r3.2xlarge.search" || "r3.4xlarge.search" || "r3.8xlarge.search" || "i2.xlarge.search" || "i2.2xlarge.search" || "d2.xlarge.search" || "d2.2xlarge.search" || "d2.4xlarge.search" || "d2.8xlarge.search" || "c4.large.search" || "c4.xlarge.search" || "c4.2xlarge.search" || "c4.4xlarge.search" || "c4.8xlarge.search" || "r4.large.search" || "r4.xlarge.search" || "r4.2xlarge.search" || "r4.4xlarge.search" || "r4.8xlarge.search" || "r4.16xlarge.search" || "i3.large.search" || "i3.xlarge.search" || "i3.2xlarge.search" || "i3.4xlarge.search" || "i3.8xlarge.search" || "i3.16xlarge.search" || "r6g.large.search" || "r6g.xlarge.search" || "r6g.2xlarge.search" || "r6g.4xlarge.search" || "r6g.8xlarge.search" || "r6g.12xlarge.search" || "m6g.large.search" || "m6g.xlarge.search" || "m6g.2xlarge.search" || "m6g.4xlarge.search" || "m6g.8xlarge.search" || "m6g.12xlarge.search" || "c6g.large.search" || "c6g.xlarge.search" || "c6g.2xlarge.search" || "c6g.4xlarge.search" || "c6g.8xlarge.search" || "c6g.12xlarge.search" || "r6gd.large.search" || "r6gd.xlarge.search" || "r6gd.2xlarge.search" || "r6gd.4xlarge.search" || "r6gd.8xlarge.search" || "r6gd.12xlarge.search" || "r6gd.16xlarge.search" || "t4g.small.search" || "t4g.medium.search",
* // DedicatedMasterCount: Number("int"),
* // WarmEnabled: true || false,
* // WarmType: "ultrawarm1.medium.search" || "ultrawarm1.large.search" || "ultrawarm1.xlarge.search",
* // WarmCount: Number("int"),
* // ColdStorageOptions: { // ColdStorageOptions
* // Enabled: true || false, // required
* // },
* // MultiAZWithStandbyEnabled: true || false,
* // },
* // Status: {
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "RequiresIndexDocuments" || "Processing" || "Active", // required
* // PendingDeletion: true || false,
* // },
* // },
* // EBSOptions: { // EBSOptionsStatus
* // Options: { // EBSOptions
* // EBSEnabled: true || false,
* // VolumeType: "standard" || "gp2" || "io1" || "gp3",
* // VolumeSize: Number("int"),
* // Iops: Number("int"),
* // Throughput: Number("int"),
* // },
* // Status: {
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "RequiresIndexDocuments" || "Processing" || "Active", // required
* // PendingDeletion: true || false,
* // },
* // },
* // AccessPolicies: { // AccessPoliciesStatus
* // Options: "STRING_VALUE", // required
* // Status: {
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "RequiresIndexDocuments" || "Processing" || "Active", // required
* // PendingDeletion: true || false,
* // },
* // },
* // SnapshotOptions: { // SnapshotOptionsStatus
* // Options: { // SnapshotOptions
* // AutomatedSnapshotStartHour: Number("int"),
* // },
* // Status: {
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "RequiresIndexDocuments" || "Processing" || "Active", // required
* // PendingDeletion: true || false,
* // },
* // },
* // VPCOptions: { // VPCDerivedInfoStatus
* // Options: { // VPCDerivedInfo
* // VPCId: "STRING_VALUE",
* // SubnetIds: [ // StringList
* // "STRING_VALUE",
* // ],
* // AvailabilityZones: [
* // "STRING_VALUE",
* // ],
* // SecurityGroupIds: [
* // "STRING_VALUE",
* // ],
* // },
* // Status: "<OptionStatus>", // required
* // },
* // CognitoOptions: { // CognitoOptionsStatus
* // Options: { // CognitoOptions
* // Enabled: true || false,
* // UserPoolId: "STRING_VALUE",
* // IdentityPoolId: "STRING_VALUE",
* // RoleArn: "STRING_VALUE",
* // },
* // Status: "<OptionStatus>", // required
* // },
* // EncryptionAtRestOptions: { // EncryptionAtRestOptionsStatus
* // Options: { // EncryptionAtRestOptions
* // Enabled: true || false,
* // KmsKeyId: "STRING_VALUE",
* // },
* // Status: "<OptionStatus>", // required
* // },
* // NodeToNodeEncryptionOptions: { // NodeToNodeEncryptionOptionsStatus
* // Options: { // NodeToNodeEncryptionOptions
* // Enabled: true || false,
* // },
* // Status: "<OptionStatus>", // required
* // },
* // AdvancedOptions: { // AdvancedOptionsStatus
* // Options: { // AdvancedOptions // required
* // "<keys>": "STRING_VALUE",
* // },
* // Status: "<OptionStatus>", // required
* // },
* // LogPublishingOptions: { // LogPublishingOptionsStatus
* // Options: { // LogPublishingOptions
* // "<keys>": { // LogPublishingOption
* // CloudWatchLogsLogGroupArn: "STRING_VALUE",
* // Enabled: true || false,
* // },
* // },
* // Status: "<OptionStatus>",
* // },
* // DomainEndpointOptions: { // DomainEndpointOptionsStatus
* // Options: { // DomainEndpointOptions
* // EnforceHTTPS: true || false,
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
* // CustomEndpointEnabled: true || false,
* // CustomEndpoint: "STRING_VALUE",
* // CustomEndpointCertificateArn: "STRING_VALUE",
* // },
* // Status: "<OptionStatus>", // required
* // },
* // AdvancedSecurityOptions: { // AdvancedSecurityOptionsStatus
* // Options: { // AdvancedSecurityOptions
* // Enabled: true || false,
* // InternalUserDatabaseEnabled: true || false,
* // SAMLOptions: { // SAMLOptionsOutput
* // Enabled: true || false,
* // Idp: { // SAMLIdp
* // MetadataContent: "STRING_VALUE", // required
* // EntityId: "STRING_VALUE", // required
* // },
* // SubjectKey: "STRING_VALUE",
* // RolesKey: "STRING_VALUE",
* // SessionTimeoutMinutes: Number("int"),
* // },
* // AnonymousAuthDisableDate: new Date("TIMESTAMP"),
* // AnonymousAuthEnabled: true || false,
* // },
* // Status: "<OptionStatus>", // required
* // },
* // AutoTuneOptions: { // AutoTuneOptionsStatus
* // Options: { // AutoTuneOptions
* // DesiredState: "ENABLED" || "DISABLED",
* // RollbackOnDisable: "NO_ROLLBACK" || "DEFAULT_ROLLBACK",
* // MaintenanceSchedules: [ // AutoTuneMaintenanceScheduleList
* // { // AutoTuneMaintenanceSchedule
* // StartAt: new Date("TIMESTAMP"),
* // Duration: { // Duration
* // Value: Number("long"),
* // Unit: "HOURS",
* // },
* // CronExpressionForRecurrence: "STRING_VALUE",
* // },
* // ],
* // UseOffPeakWindow: true || false,
* // },
* // Status: { // AutoTuneStatus
* // CreationDate: new Date("TIMESTAMP"), // required
* // UpdateDate: new Date("TIMESTAMP"), // required
* // UpdateVersion: Number("int"),
* // State: "ENABLED" || "DISABLED" || "ENABLE_IN_PROGRESS" || "DISABLE_IN_PROGRESS" || "DISABLED_AND_ROLLBACK_SCHEDULED" || "DISABLED_AND_ROLLBACK_IN_PROGRESS" || "DISABLED_AND_ROLLBACK_COMPLETE" || "DISABLED_AND_ROLLBACK_ERROR" || "ERROR", // required
* // ErrorMessage: "STRING_VALUE",
* // PendingDeletion: true || false,
* // },
* // },
* // ChangeProgressDetails: { // ChangeProgressDetails
* // ChangeId: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // },
* // OffPeakWindowOptions: { // OffPeakWindowOptionsStatus
* // Options: { // OffPeakWindowOptions
* // Enabled: true || false,
* // OffPeakWindow: { // OffPeakWindow
* // WindowStartTime: { // WindowStartTime
* // Hours: Number("long"), // required
* // Minutes: Number("long"), // required
* // },
* // },
* // },
* // Status: "<OptionStatus>",
* // },
* // SoftwareUpdateOptions: { // SoftwareUpdateOptionsStatus
* // Options: { // SoftwareUpdateOptions
* // AutoSoftwareUpdateEnabled: true || false,
* // },
* // Status: "<OptionStatus>",
* // },
* // },
* // };
*
* ```
*
* @param DescribeDomainConfigCommandInput - {@link DescribeDomainConfigCommandInput}
* @returns {@link DescribeDomainConfigCommandOutput}
* @see {@link DescribeDomainConfigCommandInput} for command's `input` shape.
* @see {@link DescribeDomainConfigCommandOutput} for command's `response` shape.
* @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
*
* @throws {@link BaseException} (client fault)
* <p>An error occurred while processing the request.</p>
*
* @throws {@link InternalException} (server fault)
* <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>An exception for accessing or deleting a resource that doesn't exist.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>An exception for accessing or deleting a resource that doesn't exist.</p>
*
* @throws {@link OpenSearchServiceException}
* <p>Base exception class for all service exceptions from OpenSearch service.</p>
*
*/
export class DescribeDomainConfigCommand extends $Command<
DescribeDomainConfigCommandInput,
DescribeDomainConfigCommandOutput,
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: DescribeDomainConfigCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: OpenSearchClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<DescribeDomainConfigCommandInput, DescribeDomainConfigCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, DescribeDomainConfigCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "OpenSearchClient";
const commandName = "DescribeDomainConfigCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: DescribeDomainConfigCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_DescribeDomainConfigCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<DescribeDomainConfigCommandOutput> {
return de_DescribeDomainConfigCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}