@aws-sdk/client-opensearch 3.687.0 → 3.691.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist-cjs/index.js +186 -3
- package/dist-es/OpenSearch.js +6 -0
- package/dist-es/commands/AssociatePackagesCommand.js +22 -0
- package/dist-es/commands/DissociatePackagesCommand.js +22 -0
- package/dist-es/commands/UpdatePackageScopeCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/models/models_1.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +108 -1
- package/dist-types/OpenSearch.d.ts +21 -0
- package/dist-types/OpenSearchClient.d.ts +5 -2
- package/dist-types/commands/AssociatePackageCommand.d.ts +19 -1
- package/dist-types/commands/AssociatePackagesCommand.d.ts +127 -0
- package/dist-types/commands/CreatePackageCommand.d.ts +33 -2
- package/dist-types/commands/DeletePackageCommand.d.ts +18 -1
- package/dist-types/commands/DescribePackagesCommand.d.ts +19 -2
- package/dist-types/commands/DissociatePackageCommand.d.ts +10 -1
- package/dist-types/commands/DissociatePackagesCommand.d.ts +116 -0
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +6 -0
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +10 -1
- package/dist-types/commands/ListPackagesForDomainCommand.d.ts +10 -1
- package/dist-types/commands/ListVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcEndpointAccessCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcEndpointsForDomainCommand.d.ts +1 -1
- package/dist-types/commands/PurchaseReservedInstanceOfferingCommand.d.ts +1 -1
- package/dist-types/commands/RejectInboundConnectionCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePackageCommand.d.ts +28 -1
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +94 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +834 -778
- package/dist-types/models/models_1.d.ts +307 -58
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/OpenSearch.d.ts +51 -0
- package/dist-types/ts3.4/OpenSearchClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/AssociatePackagesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DissociatePackagesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVpcEndpointAccessCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVpcEndpointsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVpcEndpointsForDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PurchaseReservedInstanceOfferingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RejectInboundConnectionCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdatePackageScopeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +663 -635
- package/dist-types/ts3.4/models/models_1.d.ts +125 -57
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +7 -7
|
@@ -1,6 +1,192 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { ActionType, AdvancedSecurityOptionsInput, AIMLOptionsInput, AppConfig, AutoTuneOptions, AWSServicePrincipal, ChangeProgressDetails, ClusterConfig, CognitoOptions, DataSource, DataSourceStatus, DataSourceType, DomainConfig, DomainEndpointOptions, DryRunProgressStatus, DryRunResults, EBSOptions, EncryptionAtRestOptions, IamIdentityCenterOptions, IdentityCenterOptionsInput, InboundConnection, IPAddressType, LogPublishingOption, LogType, MaintenanceType, NodeToNodeEncryptionOptions, OffPeakWindowOptions, PackageDetails, PackageSource, ScheduledAction, ServiceSoftwareOptions, SnapshotOptions, SoftwareUpdateOptions, VpcEndpoint, VPCOptions } from "./models_0";
|
|
2
|
+
import { ActionType, AdvancedSecurityOptionsInput, AIMLOptionsInput, AppConfig, AuthorizedPrincipal, AutoTuneOptions, AWSServicePrincipal, ChangeProgressDetails, ClusterConfig, CognitoOptions, DataSource, DataSourceStatus, DataSourceType, DomainConfig, DomainEndpointOptions, DryRunProgressStatus, DryRunResults, EBSOptions, EncryptionAtRestOptions, IamIdentityCenterOptions, IdentityCenterOptionsInput, InboundConnection, IPAddressType, LogPublishingOption, LogType, MaintenanceType, NodeToNodeEncryptionOptions, OffPeakWindowOptions, PackageConfiguration, PackageDetails, PackageEncryptionOptions, PackageSource, ScheduledAction, ServiceSoftwareOptions, SnapshotOptions, SoftwareUpdateOptions, VpcEndpoint, VpcEndpointSummary, VPCOptions } from "./models_0";
|
|
3
3
|
import { OpenSearchServiceException as __BaseException } from "./OpenSearchServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* <p>Container for the request parameters to the <code>ListVersions</code> operation.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ListVersionsRequest {
|
|
9
|
+
/**
|
|
10
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
11
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
MaxResults?: number | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>If your initial <code>ListVersions</code> operation returns a <code>nextToken</code>, you
|
|
17
|
+
* can include the returned <code>nextToken</code> in subsequent <code>ListVersions</code>
|
|
18
|
+
* operations, which returns results in the next page.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
NextToken?: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* <p>Container for the parameters for response received from the <code>ListVersions</code>
|
|
25
|
+
* operation.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export interface ListVersionsResponse {
|
|
29
|
+
/**
|
|
30
|
+
* <p>A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service
|
|
31
|
+
* supports.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
Versions?: string[] | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
37
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
38
|
+
* returned token to retrieve the next page.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
NextToken?: string | undefined;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
export interface ListVpcEndpointAccessRequest {
|
|
47
|
+
/**
|
|
48
|
+
* <p>The name of the OpenSearch Service domain to retrieve access information for.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
DomainName: string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>If your initial <code>ListVpcEndpointAccess</code> operation returns a
|
|
54
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
55
|
+
* <code>ListVpcEndpointAccess</code> operations, which returns results in the next page.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
NextToken?: string | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export interface ListVpcEndpointAccessResponse {
|
|
64
|
+
/**
|
|
65
|
+
* <p>A list of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM principals</a>
|
|
66
|
+
* that can currently access the domain.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
AuthorizedPrincipalList: AuthorizedPrincipal[] | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
72
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
73
|
+
* returned token to retrieve the next page.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
NextToken: string | undefined;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export interface ListVpcEndpointsRequest {
|
|
82
|
+
/**
|
|
83
|
+
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>,
|
|
84
|
+
* you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code>
|
|
85
|
+
* operations, which returns results in the next page.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
NextToken?: string | undefined;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export interface ListVpcEndpointsResponse {
|
|
94
|
+
/**
|
|
95
|
+
* <p>Information about each endpoint.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
101
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
102
|
+
* returned token to retrieve the next page.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
NextToken: string | undefined;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export interface ListVpcEndpointsForDomainRequest {
|
|
111
|
+
/**
|
|
112
|
+
* <p>The name of the domain to list associated VPC endpoints for.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
DomainName: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>If your initial <code>ListEndpointsForDomain</code> operation returns a
|
|
118
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
119
|
+
* <code>ListEndpointsForDomain</code> operations, which returns results in the next page.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
NextToken?: string | undefined;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export interface ListVpcEndpointsForDomainResponse {
|
|
128
|
+
/**
|
|
129
|
+
* <p>Information about each endpoint associated with the domain.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
135
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
136
|
+
* returned token to retrieve the next page.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
NextToken: string | undefined;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* <p>Container for request parameters to the <code>PurchaseReservedInstanceOffering</code>
|
|
143
|
+
* operation.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export interface PurchaseReservedInstanceOfferingRequest {
|
|
147
|
+
/**
|
|
148
|
+
* <p>The ID of the Reserved Instance offering to purchase.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
ReservedInstanceOfferingId: string | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* <p>A customer-specified identifier to track this reservation.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
ReservationName: string | undefined;
|
|
157
|
+
/**
|
|
158
|
+
* <p>The number of OpenSearch instances to reserve.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
InstanceCount?: number | undefined;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* <p>Represents the output of a <code>PurchaseReservedInstanceOffering</code> operation.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
export interface PurchaseReservedInstanceOfferingResponse {
|
|
168
|
+
/**
|
|
169
|
+
* <p>The ID of the Reserved Instance offering that was purchased.</p>
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
ReservedInstanceId?: string | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* <p>The customer-specified identifier used to track this reservation.</p>
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
ReservationName?: string | undefined;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* <p>Container for the request parameters to the <code>RejectInboundConnection</code> operation.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
export interface RejectInboundConnectionRequest {
|
|
184
|
+
/**
|
|
185
|
+
* <p>The unique identifier of the inbound connection to reject.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
ConnectionId: string | undefined;
|
|
189
|
+
}
|
|
4
190
|
/**
|
|
5
191
|
* <p>Represents the output of a <code>RejectInboundConnection</code> operation.</p>
|
|
6
192
|
* @public
|
|
@@ -10,7 +196,7 @@ export interface RejectInboundConnectionResponse {
|
|
|
10
196
|
* <p>Contains details about the rejected inbound connection.</p>
|
|
11
197
|
* @public
|
|
12
198
|
*/
|
|
13
|
-
Connection?: InboundConnection;
|
|
199
|
+
Connection?: InboundConnection | undefined;
|
|
14
200
|
}
|
|
15
201
|
/**
|
|
16
202
|
* <p>Container for the request parameters to the <code>RemoveTags</code> operation.</p>
|
|
@@ -42,12 +228,12 @@ export interface RevokeVpcEndpointAccessRequest {
|
|
|
42
228
|
* <p>The account ID to revoke access from.</p>
|
|
43
229
|
* @public
|
|
44
230
|
*/
|
|
45
|
-
Account?: string;
|
|
231
|
+
Account?: string | undefined;
|
|
46
232
|
/**
|
|
47
233
|
* <p>The service SP to revoke access from.</p>
|
|
48
234
|
* @public
|
|
49
235
|
*/
|
|
50
|
-
Service?: AWSServicePrincipal;
|
|
236
|
+
Service?: AWSServicePrincipal | undefined;
|
|
51
237
|
}
|
|
52
238
|
/**
|
|
53
239
|
* @public
|
|
@@ -74,7 +260,7 @@ export interface StartDomainMaintenanceRequest {
|
|
|
74
260
|
* <p>The ID of the data node.</p>
|
|
75
261
|
* @public
|
|
76
262
|
*/
|
|
77
|
-
NodeId?: string;
|
|
263
|
+
NodeId?: string | undefined;
|
|
78
264
|
}
|
|
79
265
|
/**
|
|
80
266
|
* <p>The result of a <code>StartDomainMaintenance</code> request that information about the requested action. </p>
|
|
@@ -85,7 +271,7 @@ export interface StartDomainMaintenanceResponse {
|
|
|
85
271
|
* <p>The request ID of requested action.</p>
|
|
86
272
|
* @public
|
|
87
273
|
*/
|
|
88
|
-
MaintenanceId?: string;
|
|
274
|
+
MaintenanceId?: string | undefined;
|
|
89
275
|
}
|
|
90
276
|
/**
|
|
91
277
|
* @public
|
|
@@ -135,13 +321,13 @@ export interface StartServiceSoftwareUpdateRequest {
|
|
|
135
321
|
* and <code>TIMESTAMP</code> if you do.</p>
|
|
136
322
|
* @public
|
|
137
323
|
*/
|
|
138
|
-
ScheduleAt?: ScheduleAt;
|
|
324
|
+
ScheduleAt?: ScheduleAt | undefined;
|
|
139
325
|
/**
|
|
140
326
|
* <p>The Epoch timestamp when you want the service software update to start. You only need to
|
|
141
327
|
* specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
|
|
142
328
|
* @public
|
|
143
329
|
*/
|
|
144
|
-
DesiredStartTime?: number;
|
|
330
|
+
DesiredStartTime?: number | undefined;
|
|
145
331
|
}
|
|
146
332
|
/**
|
|
147
333
|
* <p>Represents the output of a <code>StartServiceSoftwareUpdate</code> operation. Contains the
|
|
@@ -153,7 +339,7 @@ export interface StartServiceSoftwareUpdateResponse {
|
|
|
153
339
|
* <p>The current status of the OpenSearch Service software update.</p>
|
|
154
340
|
* @public
|
|
155
341
|
*/
|
|
156
|
-
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
342
|
+
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
157
343
|
}
|
|
158
344
|
/**
|
|
159
345
|
* @public
|
|
@@ -168,12 +354,12 @@ export interface UpdateApplicationRequest {
|
|
|
168
354
|
* <p>Data sources to be associated with the OpenSearch Application.</p>
|
|
169
355
|
* @public
|
|
170
356
|
*/
|
|
171
|
-
dataSources?: DataSource[];
|
|
357
|
+
dataSources?: DataSource[] | undefined;
|
|
172
358
|
/**
|
|
173
359
|
* <p>Configurations to be changed for the OpenSearch Application.</p>
|
|
174
360
|
* @public
|
|
175
361
|
*/
|
|
176
|
-
appConfigs?: AppConfig[];
|
|
362
|
+
appConfigs?: AppConfig[] | undefined;
|
|
177
363
|
}
|
|
178
364
|
/**
|
|
179
365
|
* @public
|
|
@@ -183,44 +369,44 @@ export interface UpdateApplicationResponse {
|
|
|
183
369
|
* <p>Unique identifier of the updated OpenSearch Application.</p>
|
|
184
370
|
* @public
|
|
185
371
|
*/
|
|
186
|
-
id?: string;
|
|
372
|
+
id?: string | undefined;
|
|
187
373
|
/**
|
|
188
374
|
* <p>Name of the updated OpenSearch Application.</p>
|
|
189
375
|
* @public
|
|
190
376
|
*/
|
|
191
|
-
name?: string;
|
|
377
|
+
name?: string | undefined;
|
|
192
378
|
/**
|
|
193
379
|
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
194
380
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
195
381
|
* </p>
|
|
196
382
|
* @public
|
|
197
383
|
*/
|
|
198
|
-
arn?: string;
|
|
384
|
+
arn?: string | undefined;
|
|
199
385
|
/**
|
|
200
386
|
* <p>Data sources associated with the updated OpenSearch Application.</p>
|
|
201
387
|
* @public
|
|
202
388
|
*/
|
|
203
|
-
dataSources?: DataSource[];
|
|
389
|
+
dataSources?: DataSource[] | undefined;
|
|
204
390
|
/**
|
|
205
391
|
* <p>IAM Identity Center settings for the updated OpenSearch Application.</p>
|
|
206
392
|
* @public
|
|
207
393
|
*/
|
|
208
|
-
iamIdentityCenterOptions?: IamIdentityCenterOptions;
|
|
394
|
+
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
209
395
|
/**
|
|
210
396
|
* <p>Configurations for the updated OpenSearch Application.</p>
|
|
211
397
|
* @public
|
|
212
398
|
*/
|
|
213
|
-
appConfigs?: AppConfig[];
|
|
399
|
+
appConfigs?: AppConfig[] | undefined;
|
|
214
400
|
/**
|
|
215
401
|
* <p>Timestamp at which the OpenSearch Application was created.</p>
|
|
216
402
|
* @public
|
|
217
403
|
*/
|
|
218
|
-
createdAt?: Date;
|
|
404
|
+
createdAt?: Date | undefined;
|
|
219
405
|
/**
|
|
220
406
|
* <p>Timestamp at which the OpenSearch Application was last updated.</p>
|
|
221
407
|
* @public
|
|
222
408
|
*/
|
|
223
|
-
lastUpdatedAt?: Date;
|
|
409
|
+
lastUpdatedAt?: Date | undefined;
|
|
224
410
|
}
|
|
225
411
|
/**
|
|
226
412
|
* <p>Container for the parameters to the <code>UpdateDataSource</code>
|
|
@@ -247,12 +433,12 @@ export interface UpdateDataSourceRequest {
|
|
|
247
433
|
* <p>A new description of the data source.</p>
|
|
248
434
|
* @public
|
|
249
435
|
*/
|
|
250
|
-
Description?: string;
|
|
436
|
+
Description?: string | undefined;
|
|
251
437
|
/**
|
|
252
438
|
* <p>The status of the data source update.</p>
|
|
253
439
|
* @public
|
|
254
440
|
*/
|
|
255
|
-
Status?: DataSourceStatus;
|
|
441
|
+
Status?: DataSourceStatus | undefined;
|
|
256
442
|
}
|
|
257
443
|
/**
|
|
258
444
|
* <p>The result of an <code>UpdateDataSource</code> operation.</p>
|
|
@@ -263,7 +449,7 @@ export interface UpdateDataSourceResponse {
|
|
|
263
449
|
* <p>A message associated with the updated data source.</p>
|
|
264
450
|
* @public
|
|
265
451
|
*/
|
|
266
|
-
Message?: string;
|
|
452
|
+
Message?: string | undefined;
|
|
267
453
|
}
|
|
268
454
|
/**
|
|
269
455
|
* @public
|
|
@@ -292,30 +478,30 @@ export interface UpdateDomainConfigRequest {
|
|
|
292
478
|
* number of EC2 instances.</p>
|
|
293
479
|
* @public
|
|
294
480
|
*/
|
|
295
|
-
ClusterConfig?: ClusterConfig;
|
|
481
|
+
ClusterConfig?: ClusterConfig | undefined;
|
|
296
482
|
/**
|
|
297
483
|
* <p>The type and size of the EBS volume to attach to instances in the domain.</p>
|
|
298
484
|
* @public
|
|
299
485
|
*/
|
|
300
|
-
EBSOptions?: EBSOptions;
|
|
486
|
+
EBSOptions?: EBSOptions | undefined;
|
|
301
487
|
/**
|
|
302
488
|
* <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours.
|
|
303
489
|
* </p>
|
|
304
490
|
* @public
|
|
305
491
|
*/
|
|
306
|
-
SnapshotOptions?: SnapshotOptions;
|
|
492
|
+
SnapshotOptions?: SnapshotOptions | undefined;
|
|
307
493
|
/**
|
|
308
494
|
* <p>Options to specify the subnets and security groups for a VPC endpoint. For more information,
|
|
309
495
|
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching
|
|
310
496
|
* your Amazon OpenSearch Service domains using a VPC</a>.</p>
|
|
311
497
|
* @public
|
|
312
498
|
*/
|
|
313
|
-
VPCOptions?: VPCOptions;
|
|
499
|
+
VPCOptions?: VPCOptions | undefined;
|
|
314
500
|
/**
|
|
315
501
|
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>
|
|
316
502
|
* @public
|
|
317
503
|
*/
|
|
318
|
-
CognitoOptions?: CognitoOptions;
|
|
504
|
+
CognitoOptions?: CognitoOptions | undefined;
|
|
319
505
|
/**
|
|
320
506
|
* <p>Key-value pairs to specify advanced configuration options. The following key-value pairs are
|
|
321
507
|
* supported:</p>
|
|
@@ -345,12 +531,12 @@ export interface UpdateDomainConfigRequest {
|
|
|
345
531
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</p>
|
|
346
532
|
* @public
|
|
347
533
|
*/
|
|
348
|
-
AdvancedOptions?: Record<string, string
|
|
534
|
+
AdvancedOptions?: Record<string, string> | undefined;
|
|
349
535
|
/**
|
|
350
536
|
* <p>Identity and Access Management (IAM) access policy as a JSON-formatted string.</p>
|
|
351
537
|
* @public
|
|
352
538
|
*/
|
|
353
|
-
AccessPolicies?: string;
|
|
539
|
+
AccessPolicies?: string | undefined;
|
|
354
540
|
/**
|
|
355
541
|
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across
|
|
356
542
|
* IPv4 and IPv6 address types, and is the recommended option.
|
|
@@ -358,50 +544,50 @@ export interface UpdateDomainConfigRequest {
|
|
|
358
544
|
* </p>
|
|
359
545
|
* @public
|
|
360
546
|
*/
|
|
361
|
-
IPAddressType?: IPAddressType;
|
|
547
|
+
IPAddressType?: IPAddressType | undefined;
|
|
362
548
|
/**
|
|
363
549
|
* <p>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</p>
|
|
364
550
|
* @public
|
|
365
551
|
*/
|
|
366
|
-
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption
|
|
552
|
+
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
367
553
|
/**
|
|
368
554
|
* <p>Encryption at rest options for the domain.</p>
|
|
369
555
|
* @public
|
|
370
556
|
*/
|
|
371
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
557
|
+
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
|
|
372
558
|
/**
|
|
373
559
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
374
560
|
* traffic.</p>
|
|
375
561
|
* @public
|
|
376
562
|
*/
|
|
377
|
-
DomainEndpointOptions?: DomainEndpointOptions;
|
|
563
|
+
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
378
564
|
/**
|
|
379
565
|
* <p>Node-to-node encryption options for the domain.</p>
|
|
380
566
|
* @public
|
|
381
567
|
*/
|
|
382
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
568
|
+
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
383
569
|
/**
|
|
384
570
|
* <p>Options for fine-grained access control.</p>
|
|
385
571
|
* @public
|
|
386
572
|
*/
|
|
387
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
|
|
573
|
+
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
388
574
|
/**
|
|
389
575
|
* <p>Container for IAM Identity Center Options settings.</p>
|
|
390
576
|
* @public
|
|
391
577
|
*/
|
|
392
|
-
IdentityCenterOptions?: IdentityCenterOptionsInput;
|
|
578
|
+
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
393
579
|
/**
|
|
394
580
|
* <p>Options for Auto-Tune.</p>
|
|
395
581
|
* @public
|
|
396
582
|
*/
|
|
397
|
-
AutoTuneOptions?: AutoTuneOptions;
|
|
583
|
+
AutoTuneOptions?: AutoTuneOptions | undefined;
|
|
398
584
|
/**
|
|
399
585
|
* <p>This flag, when set to True, specifies whether the <code>UpdateDomain</code> request should
|
|
400
586
|
* return the results of a dry run analysis without actually applying the change. A dry run
|
|
401
587
|
* determines what type of deployment the update will cause.</p>
|
|
402
588
|
* @public
|
|
403
589
|
*/
|
|
404
|
-
DryRun?: boolean;
|
|
590
|
+
DryRun?: boolean | undefined;
|
|
405
591
|
/**
|
|
406
592
|
* <p>The type of dry run to perform.</p>
|
|
407
593
|
* <ul>
|
|
@@ -418,22 +604,22 @@ export interface UpdateDomainConfigRequest {
|
|
|
418
604
|
* </ul>
|
|
419
605
|
* @public
|
|
420
606
|
*/
|
|
421
|
-
DryRunMode?: DryRunMode;
|
|
607
|
+
DryRunMode?: DryRunMode | undefined;
|
|
422
608
|
/**
|
|
423
609
|
* <p>Off-peak window options for the domain.</p>
|
|
424
610
|
* @public
|
|
425
611
|
*/
|
|
426
|
-
OffPeakWindowOptions?: OffPeakWindowOptions;
|
|
612
|
+
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
427
613
|
/**
|
|
428
614
|
* <p>Service software update options for the domain.</p>
|
|
429
615
|
* @public
|
|
430
616
|
*/
|
|
431
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptions;
|
|
617
|
+
SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
|
|
432
618
|
/**
|
|
433
619
|
* <p>Options for all machine learning features for the specified domain.</p>
|
|
434
620
|
* @public
|
|
435
621
|
*/
|
|
436
|
-
AIMLOptions?: AIMLOptionsInput;
|
|
622
|
+
AIMLOptions?: AIMLOptionsInput | undefined;
|
|
437
623
|
}
|
|
438
624
|
/**
|
|
439
625
|
* <p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain being
|
|
@@ -450,12 +636,12 @@ export interface UpdateDomainConfigResponse {
|
|
|
450
636
|
* <p>Results of the dry run performed in the update domain request.</p>
|
|
451
637
|
* @public
|
|
452
638
|
*/
|
|
453
|
-
DryRunResults?: DryRunResults;
|
|
639
|
+
DryRunResults?: DryRunResults | undefined;
|
|
454
640
|
/**
|
|
455
641
|
* <p>The status of the dry run being performed on the domain, if any.</p>
|
|
456
642
|
* @public
|
|
457
643
|
*/
|
|
458
|
-
DryRunProgressStatus?: DryRunProgressStatus;
|
|
644
|
+
DryRunProgressStatus?: DryRunProgressStatus | undefined;
|
|
459
645
|
}
|
|
460
646
|
/**
|
|
461
647
|
* <p>Container for request parameters to the <code>UpdatePackage</code> operation.</p>
|
|
@@ -476,13 +662,23 @@ export interface UpdatePackageRequest {
|
|
|
476
662
|
* <p>A new description of the package.</p>
|
|
477
663
|
* @public
|
|
478
664
|
*/
|
|
479
|
-
PackageDescription?: string;
|
|
665
|
+
PackageDescription?: string | undefined;
|
|
480
666
|
/**
|
|
481
667
|
* <p>Commit message for the updated file, which is shown as part of
|
|
482
668
|
* <code>GetPackageVersionHistoryResponse</code>.</p>
|
|
483
669
|
* @public
|
|
484
670
|
*/
|
|
485
|
-
CommitMessage?: string;
|
|
671
|
+
CommitMessage?: string | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The updated configuration details for a package.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
PackageConfiguration?: PackageConfiguration | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* <p>Encryption options for a package.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
486
682
|
}
|
|
487
683
|
/**
|
|
488
684
|
* <p>Container for the response returned by the <code>UpdatePackage</code> operation.</p>
|
|
@@ -493,7 +689,60 @@ export interface UpdatePackageResponse {
|
|
|
493
689
|
* <p>Information about a package.</p>
|
|
494
690
|
* @public
|
|
495
691
|
*/
|
|
496
|
-
PackageDetails?: PackageDetails;
|
|
692
|
+
PackageDetails?: PackageDetails | undefined;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* @public
|
|
696
|
+
* @enum
|
|
697
|
+
*/
|
|
698
|
+
export declare const PackageScopeOperationEnum: {
|
|
699
|
+
readonly ADD: "ADD";
|
|
700
|
+
readonly OVERRIDE: "OVERRIDE";
|
|
701
|
+
readonly REMOVE: "REMOVE";
|
|
702
|
+
};
|
|
703
|
+
/**
|
|
704
|
+
* @public
|
|
705
|
+
*/
|
|
706
|
+
export type PackageScopeOperationEnum = (typeof PackageScopeOperationEnum)[keyof typeof PackageScopeOperationEnum];
|
|
707
|
+
/**
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
export interface UpdatePackageScopeRequest {
|
|
711
|
+
/**
|
|
712
|
+
* <p>ID of the package whose scope is being updated.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
PackageID: string | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p> The operation to perform on the package scope (e.g., add/remove/override users).</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
Operation: PackageScopeOperationEnum | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p> List of users to be added or removed from the package scope.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
PackageUserList: string[] | undefined;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
export interface UpdatePackageScopeResponse {
|
|
731
|
+
/**
|
|
732
|
+
* <p> ID of the package whose scope was updated.</p>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
PackageID?: string | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* <p>The operation that was performed on the package scope.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
Operation?: PackageScopeOperationEnum | undefined;
|
|
741
|
+
/**
|
|
742
|
+
* <p> List of users who have access to the package after the scope update.</p>
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
PackageUserList?: string[] | undefined;
|
|
497
746
|
}
|
|
498
747
|
/**
|
|
499
748
|
* <p>An exception for attempting to schedule a domain action during an unavailable time slot.</p>
|
|
@@ -506,7 +755,7 @@ export declare class SlotNotAvailableException extends __BaseException {
|
|
|
506
755
|
* <p>Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.</p>
|
|
507
756
|
* @public
|
|
508
757
|
*/
|
|
509
|
-
SlotSuggestions?: number[];
|
|
758
|
+
SlotSuggestions?: number[] | undefined;
|
|
510
759
|
/**
|
|
511
760
|
* @internal
|
|
512
761
|
*/
|
|
@@ -560,7 +809,7 @@ export interface UpdateScheduledActionRequest {
|
|
|
560
809
|
* parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
|
|
561
810
|
* @public
|
|
562
811
|
*/
|
|
563
|
-
DesiredStartTime?: number;
|
|
812
|
+
DesiredStartTime?: number | undefined;
|
|
564
813
|
}
|
|
565
814
|
/**
|
|
566
815
|
* @public
|
|
@@ -570,7 +819,7 @@ export interface UpdateScheduledActionResponse {
|
|
|
570
819
|
* <p>Information about the rescheduled action.</p>
|
|
571
820
|
* @public
|
|
572
821
|
*/
|
|
573
|
-
ScheduledAction?: ScheduledAction;
|
|
822
|
+
ScheduledAction?: ScheduledAction | undefined;
|
|
574
823
|
}
|
|
575
824
|
/**
|
|
576
825
|
* @public
|
|
@@ -618,7 +867,7 @@ export interface UpgradeDomainRequest {
|
|
|
618
867
|
* actually perform the upgrade.</p>
|
|
619
868
|
* @public
|
|
620
869
|
*/
|
|
621
|
-
PerformCheckOnly?: boolean;
|
|
870
|
+
PerformCheckOnly?: boolean | undefined;
|
|
622
871
|
/**
|
|
623
872
|
* <p>Only supports the <code>override_main_response_version</code> parameter and not other
|
|
624
873
|
* advanced options. You can only include this option when upgrading to an OpenSearch version.
|
|
@@ -626,7 +875,7 @@ export interface UpgradeDomainRequest {
|
|
|
626
875
|
* Elasticsearch OSS clients and plugins.</p>
|
|
627
876
|
* @public
|
|
628
877
|
*/
|
|
629
|
-
AdvancedOptions?: Record<string, string
|
|
878
|
+
AdvancedOptions?: Record<string, string> | undefined;
|
|
630
879
|
}
|
|
631
880
|
/**
|
|
632
881
|
* <p>Container for the response returned by <code>UpgradeDomain</code> operation.</p>
|
|
@@ -637,32 +886,32 @@ export interface UpgradeDomainResponse {
|
|
|
637
886
|
* <p>The unique identifier of the domain upgrade.</p>
|
|
638
887
|
* @public
|
|
639
888
|
*/
|
|
640
|
-
UpgradeId?: string;
|
|
889
|
+
UpgradeId?: string | undefined;
|
|
641
890
|
/**
|
|
642
891
|
* <p>The name of the domain that was upgraded.</p>
|
|
643
892
|
* @public
|
|
644
893
|
*/
|
|
645
|
-
DomainName?: string;
|
|
894
|
+
DomainName?: string | undefined;
|
|
646
895
|
/**
|
|
647
896
|
* <p>OpenSearch or Elasticsearch version that the domain was upgraded to.</p>
|
|
648
897
|
* @public
|
|
649
898
|
*/
|
|
650
|
-
TargetVersion?: string;
|
|
899
|
+
TargetVersion?: string | undefined;
|
|
651
900
|
/**
|
|
652
901
|
* <p>When true, indicates that an upgrade eligibility check was performed.</p>
|
|
653
902
|
* @public
|
|
654
903
|
*/
|
|
655
|
-
PerformCheckOnly?: boolean;
|
|
904
|
+
PerformCheckOnly?: boolean | undefined;
|
|
656
905
|
/**
|
|
657
906
|
* <p>The advanced options configuration for the domain.</p>
|
|
658
907
|
* @public
|
|
659
908
|
*/
|
|
660
|
-
AdvancedOptions?: Record<string, string
|
|
909
|
+
AdvancedOptions?: Record<string, string> | undefined;
|
|
661
910
|
/**
|
|
662
911
|
* <p>Container for information about a configuration change happening on a domain.</p>
|
|
663
912
|
* @public
|
|
664
913
|
*/
|
|
665
|
-
ChangeProgressDetails?: ChangeProgressDetails;
|
|
914
|
+
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
666
915
|
}
|
|
667
916
|
/**
|
|
668
917
|
* @internal
|