@aws-sdk/client-opensearch 3.933.0 → 3.935.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/dist-cjs/index.js +530 -530
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +439 -0
- package/dist-es/models/errors.js +171 -0
- package/dist-es/models/models_0.js +1 -574
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -2
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainMaintenancesCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainNamesCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +1 -1
- package/dist-types/commands/ListInstanceTypeDetailsCommand.d.ts +1 -1
- package/dist-types/commands/ListPackagesForDomainCommand.d.ts +1 -1
- package/dist-types/commands/ListScheduledActionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsCommand.d.ts +1 -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/PutDefaultApplicationSettingCommand.d.ts +1 -1
- package/dist-types/commands/RejectInboundConnectionCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsCommand.d.ts +1 -1
- package/dist-types/commands/RevokeVpcEndpointAccessCommand.d.ts +1 -1
- package/dist-types/commands/StartDomainMaintenanceCommand.d.ts +1 -1
- package/dist-types/commands/StartServiceSoftwareUpdateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +1 -1
- package/dist-types/commands/UpgradeDomainCommand.d.ts +1 -1
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +927 -0
- package/dist-types/models/errors.d.ts +175 -0
- package/dist-types/models/models_0.d.ts +1523 -1031
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListDirectQueryDataSourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainMaintenancesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainsForPackageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInstanceTypeDetailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPackagesForDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListScheduledActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +1 -1
- 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/PutDefaultApplicationSettingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RejectInboundConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RevokeVpcEndpointAccessCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartDomainMaintenanceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartServiceSoftwareUpdateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateApplicationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDirectQueryDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePackageScopeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateScheduledActionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateVpcEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpgradeDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +535 -0
- package/dist-types/ts3.4/models/errors.d.ts +98 -0
- package/dist-types/ts3.4/models/models_0.d.ts +381 -597
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-es/models/models_1.js +0 -37
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/models/models_1.d.ts +0 -1597
- package/dist-types/ts3.4/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/models_1.d.ts +0 -406
|
@@ -1,1597 +0,0 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import { ActionSeverity, ActionStatus, ActionType, AdvancedSecurityOptionsInput, AIMLOptionsInput, AppConfig, AuthorizedPrincipal, AutoTuneOptions, AWSServicePrincipal, ChangeProgressDetails, ClusterConfig, CognitoOptions, DataSource, DataSourceDetails, DataSourceStatus, DataSourceType, DirectQueryDataSourceType, DomainConfig, DomainEndpointOptions, DomainPackageDetails, DryRunProgressStatus, DryRunResults, EBSOptions, EncryptionAtRestOptions, IamIdentityCenterOptions, IdentityCenterOptionsInput, InboundConnection, IndexStatus, IPAddressType, LogPublishingOption, LogType, MaintenanceStatus, MaintenanceType, NodeToNodeEncryptionOptions, OffPeakWindowOptions, OpenSearchPartitionInstanceType, PackageConfiguration, PackageDetails, PackageEncryptionOptions, PackageSource, ServiceSoftwareOptions, SnapshotOptions, SoftwareUpdateOptions, Tag, VpcEndpoint, VpcEndpointSummary, VPCOptions } from "./models_0";
|
|
4
|
-
import { OpenSearchServiceException as __BaseException } from "./OpenSearchServiceException";
|
|
5
|
-
/**
|
|
6
|
-
* <p>The result of a <code>ListDataSources</code> operation.</p>
|
|
7
|
-
* @public
|
|
8
|
-
*/
|
|
9
|
-
export interface ListDataSourcesResponse {
|
|
10
|
-
/**
|
|
11
|
-
* <p>A list of data sources associated with specified domain.</p>
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
|
-
DataSources?: DataSourceDetails[] | undefined;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @public
|
|
18
|
-
*/
|
|
19
|
-
export interface ListDirectQueryDataSourcesRequest {
|
|
20
|
-
/**
|
|
21
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
22
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
23
|
-
* again using the returned token to retrieve the next page.</p>
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
NextToken?: string | undefined;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* <p> The configuration details for a data source that can be directly queried. </p>
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
|
-
export interface DirectQueryDataSource {
|
|
33
|
-
/**
|
|
34
|
-
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
35
|
-
* Service environment. </p>
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
|
-
DataSourceName?: string | undefined;
|
|
39
|
-
/**
|
|
40
|
-
* <p> The supported Amazon Web Services service that is used as the source for direct
|
|
41
|
-
* queries in OpenSearch Service. </p>
|
|
42
|
-
* @public
|
|
43
|
-
*/
|
|
44
|
-
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
45
|
-
/**
|
|
46
|
-
* <p> A description that provides additional context and details about the data
|
|
47
|
-
* source.</p>
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
Description?: string | undefined;
|
|
51
|
-
/**
|
|
52
|
-
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
53
|
-
* associated with the direct query data source. </p>
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
|
-
OpenSearchArns?: string[] | undefined;
|
|
57
|
-
/**
|
|
58
|
-
* <p> The unique, system-generated identifier that represents the data source.</p>
|
|
59
|
-
* @public
|
|
60
|
-
*/
|
|
61
|
-
DataSourceArn?: string | undefined;
|
|
62
|
-
/**
|
|
63
|
-
* <p> A list of tags attached to a direct query data source.</p>
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
|
-
TagList?: Tag[] | undefined;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
|
-
export interface ListDirectQueryDataSourcesResponse {
|
|
72
|
-
/**
|
|
73
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
74
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
75
|
-
* again using the returned token to retrieve the next page.</p>
|
|
76
|
-
* @public
|
|
77
|
-
*/
|
|
78
|
-
NextToken?: string | undefined;
|
|
79
|
-
/**
|
|
80
|
-
* <p> A list of the direct query data sources that are returned by the
|
|
81
|
-
* <code>ListDirectQueryDataSources</code> API operation. </p>
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
|
-
DirectQueryDataSources?: DirectQueryDataSource[] | undefined;
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
88
|
-
* operation.</p>
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
|
-
export interface ListDomainMaintenancesRequest {
|
|
92
|
-
/**
|
|
93
|
-
* <p>The name of the domain.</p>
|
|
94
|
-
* @public
|
|
95
|
-
*/
|
|
96
|
-
DomainName: string | undefined;
|
|
97
|
-
/**
|
|
98
|
-
* <p>The name of the action.</p>
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
Action?: MaintenanceType | undefined;
|
|
102
|
-
/**
|
|
103
|
-
* <p>The status of the action.</p>
|
|
104
|
-
* @public
|
|
105
|
-
*/
|
|
106
|
-
Status?: MaintenanceStatus | undefined;
|
|
107
|
-
/**
|
|
108
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
109
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
110
|
-
* @public
|
|
111
|
-
*/
|
|
112
|
-
MaxResults?: number | undefined;
|
|
113
|
-
/**
|
|
114
|
-
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
115
|
-
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
116
|
-
* <code>ListDomainMaintenances</code> operations, which returns results in the next
|
|
117
|
-
* page.</p>
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
|
-
NextToken?: string | undefined;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* <p>Container for the domain maintenance details.</p>
|
|
124
|
-
* @public
|
|
125
|
-
*/
|
|
126
|
-
export interface DomainMaintenanceDetails {
|
|
127
|
-
/**
|
|
128
|
-
* <p>The ID of the requested action.</p>
|
|
129
|
-
* @public
|
|
130
|
-
*/
|
|
131
|
-
MaintenanceId?: string | undefined;
|
|
132
|
-
/**
|
|
133
|
-
* <p>The name of the domain.</p>
|
|
134
|
-
* @public
|
|
135
|
-
*/
|
|
136
|
-
DomainName?: string | undefined;
|
|
137
|
-
/**
|
|
138
|
-
* <p>The name of the action.</p>
|
|
139
|
-
* @public
|
|
140
|
-
*/
|
|
141
|
-
Action?: MaintenanceType | undefined;
|
|
142
|
-
/**
|
|
143
|
-
* <p>The ID of the data node.</p>
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
|
-
NodeId?: string | undefined;
|
|
147
|
-
/**
|
|
148
|
-
* <p>The status of the action.</p>
|
|
149
|
-
* @public
|
|
150
|
-
*/
|
|
151
|
-
Status?: MaintenanceStatus | undefined;
|
|
152
|
-
/**
|
|
153
|
-
* <p>The status message for the action.</p>
|
|
154
|
-
* @public
|
|
155
|
-
*/
|
|
156
|
-
StatusMessage?: string | undefined;
|
|
157
|
-
/**
|
|
158
|
-
* <p>The time at which the action was created.</p>
|
|
159
|
-
* @public
|
|
160
|
-
*/
|
|
161
|
-
CreatedAt?: Date | undefined;
|
|
162
|
-
/**
|
|
163
|
-
* <p>The time at which the action was updated.</p>
|
|
164
|
-
* @public
|
|
165
|
-
*/
|
|
166
|
-
UpdatedAt?: Date | undefined;
|
|
167
|
-
}
|
|
168
|
-
/**
|
|
169
|
-
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information
|
|
170
|
-
* about the requested actions. </p>
|
|
171
|
-
* @public
|
|
172
|
-
*/
|
|
173
|
-
export interface ListDomainMaintenancesResponse {
|
|
174
|
-
/**
|
|
175
|
-
* <p>A list of the submitted maintenance actions.</p>
|
|
176
|
-
* @public
|
|
177
|
-
*/
|
|
178
|
-
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
179
|
-
/**
|
|
180
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
181
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
182
|
-
* again using the returned token to retrieve the next page.</p>
|
|
183
|
-
* @public
|
|
184
|
-
*/
|
|
185
|
-
NextToken?: string | undefined;
|
|
186
|
-
}
|
|
187
|
-
/**
|
|
188
|
-
* @public
|
|
189
|
-
* @enum
|
|
190
|
-
*/
|
|
191
|
-
export declare const EngineType: {
|
|
192
|
-
readonly Elasticsearch: "Elasticsearch";
|
|
193
|
-
readonly OpenSearch: "OpenSearch";
|
|
194
|
-
};
|
|
195
|
-
/**
|
|
196
|
-
* @public
|
|
197
|
-
*/
|
|
198
|
-
export type EngineType = (typeof EngineType)[keyof typeof EngineType];
|
|
199
|
-
/**
|
|
200
|
-
* <p>Container for the parameters to the <code>ListDomainNames</code> operation.</p>
|
|
201
|
-
* @public
|
|
202
|
-
*/
|
|
203
|
-
export interface ListDomainNamesRequest {
|
|
204
|
-
/**
|
|
205
|
-
* <p>Filters the output by domain engine type.</p>
|
|
206
|
-
* @public
|
|
207
|
-
*/
|
|
208
|
-
EngineType?: EngineType | undefined;
|
|
209
|
-
}
|
|
210
|
-
/**
|
|
211
|
-
* <p>Information about an OpenSearch Service domain.</p>
|
|
212
|
-
* @public
|
|
213
|
-
*/
|
|
214
|
-
export interface DomainInfo {
|
|
215
|
-
/**
|
|
216
|
-
* <p>Name of the domain.</p>
|
|
217
|
-
* @public
|
|
218
|
-
*/
|
|
219
|
-
DomainName?: string | undefined;
|
|
220
|
-
/**
|
|
221
|
-
* <p>The type of search engine that the domain is running.<code>OpenSearch</code> for an
|
|
222
|
-
* OpenSearch engine, or <code>Elasticsearch</code> for a legacy Elasticsearch OSS
|
|
223
|
-
* engine.</p>
|
|
224
|
-
* @public
|
|
225
|
-
*/
|
|
226
|
-
EngineType?: EngineType | undefined;
|
|
227
|
-
}
|
|
228
|
-
/**
|
|
229
|
-
* <p>The results of a <code>ListDomainNames</code> operation. Contains the names of all
|
|
230
|
-
* domains owned by this account and their respective engine types.</p>
|
|
231
|
-
* @public
|
|
232
|
-
*/
|
|
233
|
-
export interface ListDomainNamesResponse {
|
|
234
|
-
/**
|
|
235
|
-
* <p>The names of all OpenSearch Service domains owned by the current user and their
|
|
236
|
-
* respective engine types.</p>
|
|
237
|
-
* @public
|
|
238
|
-
*/
|
|
239
|
-
DomainNames?: DomainInfo[] | undefined;
|
|
240
|
-
}
|
|
241
|
-
/**
|
|
242
|
-
* <p>Container for the request parameters to the <code>ListDomainsForPackage</code>
|
|
243
|
-
* operation.</p>
|
|
244
|
-
* @public
|
|
245
|
-
*/
|
|
246
|
-
export interface ListDomainsForPackageRequest {
|
|
247
|
-
/**
|
|
248
|
-
* <p>The unique identifier of the package for which to list associated domains.</p>
|
|
249
|
-
* @public
|
|
250
|
-
*/
|
|
251
|
-
PackageID: string | undefined;
|
|
252
|
-
/**
|
|
253
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
254
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
255
|
-
* @public
|
|
256
|
-
*/
|
|
257
|
-
MaxResults?: number | undefined;
|
|
258
|
-
/**
|
|
259
|
-
* <p>If your initial <code>ListDomainsForPackage</code> operation returns a
|
|
260
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
261
|
-
* subsequent <code>ListDomainsForPackage</code> operations, which returns results in the
|
|
262
|
-
* next page.</p>
|
|
263
|
-
* @public
|
|
264
|
-
*/
|
|
265
|
-
NextToken?: string | undefined;
|
|
266
|
-
}
|
|
267
|
-
/**
|
|
268
|
-
* <p>Container for the response parameters to the <code>ListDomainsForPackage</code>
|
|
269
|
-
* operation.</p>
|
|
270
|
-
* @public
|
|
271
|
-
*/
|
|
272
|
-
export interface ListDomainsForPackageResponse {
|
|
273
|
-
/**
|
|
274
|
-
* <p>Information about all domains associated with a package.</p>
|
|
275
|
-
* @public
|
|
276
|
-
*/
|
|
277
|
-
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
278
|
-
/**
|
|
279
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
280
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
281
|
-
* again using the returned token to retrieve the next page.</p>
|
|
282
|
-
* @public
|
|
283
|
-
*/
|
|
284
|
-
NextToken?: string | undefined;
|
|
285
|
-
}
|
|
286
|
-
/**
|
|
287
|
-
* @public
|
|
288
|
-
*/
|
|
289
|
-
export interface ListInstanceTypeDetailsRequest {
|
|
290
|
-
/**
|
|
291
|
-
* <p>The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
|
|
292
|
-
* OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</p>
|
|
293
|
-
* @public
|
|
294
|
-
*/
|
|
295
|
-
EngineVersion: string | undefined;
|
|
296
|
-
/**
|
|
297
|
-
* <p>The name of the domain.</p>
|
|
298
|
-
* @public
|
|
299
|
-
*/
|
|
300
|
-
DomainName?: string | undefined;
|
|
301
|
-
/**
|
|
302
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
303
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
MaxResults?: number | undefined;
|
|
307
|
-
/**
|
|
308
|
-
* <p>If your initial <code>ListInstanceTypeDetails</code> operation returns a
|
|
309
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
310
|
-
* subsequent <code>ListInstanceTypeDetails</code> operations, which returns results in the
|
|
311
|
-
* next page.</p>
|
|
312
|
-
* @public
|
|
313
|
-
*/
|
|
314
|
-
NextToken?: string | undefined;
|
|
315
|
-
/**
|
|
316
|
-
* <p>An optional parameter that specifies the Availability Zones for the domain.</p>
|
|
317
|
-
* @public
|
|
318
|
-
*/
|
|
319
|
-
RetrieveAZs?: boolean | undefined;
|
|
320
|
-
/**
|
|
321
|
-
* <p>An optional parameter that lists information for a given instance type.</p>
|
|
322
|
-
* @public
|
|
323
|
-
*/
|
|
324
|
-
InstanceType?: string | undefined;
|
|
325
|
-
}
|
|
326
|
-
/**
|
|
327
|
-
* <p>Lists all instance types and available features for a given OpenSearch or Elasticsearch
|
|
328
|
-
* version.</p>
|
|
329
|
-
* @public
|
|
330
|
-
*/
|
|
331
|
-
export interface InstanceTypeDetails {
|
|
332
|
-
/**
|
|
333
|
-
* <p>The instance type.</p>
|
|
334
|
-
* @public
|
|
335
|
-
*/
|
|
336
|
-
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
337
|
-
/**
|
|
338
|
-
* <p>Whether encryption at rest and node-to-node encryption are supported for the instance
|
|
339
|
-
* type.</p>
|
|
340
|
-
* @public
|
|
341
|
-
*/
|
|
342
|
-
EncryptionEnabled?: boolean | undefined;
|
|
343
|
-
/**
|
|
344
|
-
* <p>Whether Amazon Cognito access is supported for the instance type.</p>
|
|
345
|
-
* @public
|
|
346
|
-
*/
|
|
347
|
-
CognitoEnabled?: boolean | undefined;
|
|
348
|
-
/**
|
|
349
|
-
* <p>Whether logging is supported for the instance type.</p>
|
|
350
|
-
* @public
|
|
351
|
-
*/
|
|
352
|
-
AppLogsEnabled?: boolean | undefined;
|
|
353
|
-
/**
|
|
354
|
-
* <p>Whether fine-grained access control is supported for the instance type.</p>
|
|
355
|
-
* @public
|
|
356
|
-
*/
|
|
357
|
-
AdvancedSecurityEnabled?: boolean | undefined;
|
|
358
|
-
/**
|
|
359
|
-
* <p>Whether UltraWarm is supported for the instance type.</p>
|
|
360
|
-
* @public
|
|
361
|
-
*/
|
|
362
|
-
WarmEnabled?: boolean | undefined;
|
|
363
|
-
/**
|
|
364
|
-
* <p>Whether the instance acts as a data node, a dedicated master node, or an UltraWarm
|
|
365
|
-
* node.</p>
|
|
366
|
-
* @public
|
|
367
|
-
*/
|
|
368
|
-
InstanceRole?: string[] | undefined;
|
|
369
|
-
/**
|
|
370
|
-
* <p>The supported Availability Zones for the instance type.</p>
|
|
371
|
-
* @public
|
|
372
|
-
*/
|
|
373
|
-
AvailabilityZones?: string[] | undefined;
|
|
374
|
-
}
|
|
375
|
-
/**
|
|
376
|
-
* @public
|
|
377
|
-
*/
|
|
378
|
-
export interface ListInstanceTypeDetailsResponse {
|
|
379
|
-
/**
|
|
380
|
-
* <p>Lists all supported instance types and features for the given OpenSearch or
|
|
381
|
-
* Elasticsearch version.</p>
|
|
382
|
-
* @public
|
|
383
|
-
*/
|
|
384
|
-
InstanceTypeDetails?: InstanceTypeDetails[] | undefined;
|
|
385
|
-
/**
|
|
386
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
387
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
388
|
-
* again using the returned token to retrieve the next page.</p>
|
|
389
|
-
* @public
|
|
390
|
-
*/
|
|
391
|
-
NextToken?: string | undefined;
|
|
392
|
-
}
|
|
393
|
-
/**
|
|
394
|
-
* <p>Container for the request parameters to the <code>ListPackagesForDomain</code>
|
|
395
|
-
* operation.</p>
|
|
396
|
-
* @public
|
|
397
|
-
*/
|
|
398
|
-
export interface ListPackagesForDomainRequest {
|
|
399
|
-
/**
|
|
400
|
-
* <p>The name of the domain for which you want to list associated packages.</p>
|
|
401
|
-
* @public
|
|
402
|
-
*/
|
|
403
|
-
DomainName: string | undefined;
|
|
404
|
-
/**
|
|
405
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
406
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
407
|
-
* @public
|
|
408
|
-
*/
|
|
409
|
-
MaxResults?: number | undefined;
|
|
410
|
-
/**
|
|
411
|
-
* <p>If your initial <code>ListPackagesForDomain</code> operation returns a
|
|
412
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
413
|
-
* subsequent <code>ListPackagesForDomain</code> operations, which returns results in the
|
|
414
|
-
* next page.</p>
|
|
415
|
-
* @public
|
|
416
|
-
*/
|
|
417
|
-
NextToken?: string | undefined;
|
|
418
|
-
}
|
|
419
|
-
/**
|
|
420
|
-
* <p>Container for the response parameters to the <code>ListPackagesForDomain</code>
|
|
421
|
-
* operation.</p>
|
|
422
|
-
* @public
|
|
423
|
-
*/
|
|
424
|
-
export interface ListPackagesForDomainResponse {
|
|
425
|
-
/**
|
|
426
|
-
* <p>List of all packages associated with a domain.</p>
|
|
427
|
-
* @public
|
|
428
|
-
*/
|
|
429
|
-
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
430
|
-
/**
|
|
431
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
432
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
433
|
-
* again using the returned token to retrieve the next page.</p>
|
|
434
|
-
* @public
|
|
435
|
-
*/
|
|
436
|
-
NextToken?: string | undefined;
|
|
437
|
-
}
|
|
438
|
-
/**
|
|
439
|
-
* @public
|
|
440
|
-
*/
|
|
441
|
-
export interface ListScheduledActionsRequest {
|
|
442
|
-
/**
|
|
443
|
-
* <p>The name of the domain.</p>
|
|
444
|
-
* @public
|
|
445
|
-
*/
|
|
446
|
-
DomainName: string | undefined;
|
|
447
|
-
/**
|
|
448
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
449
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
450
|
-
* @public
|
|
451
|
-
*/
|
|
452
|
-
MaxResults?: number | undefined;
|
|
453
|
-
/**
|
|
454
|
-
* <p>If your initial <code>ListScheduledActions</code> operation returns a
|
|
455
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
456
|
-
* subsequent <code>ListScheduledActions</code> operations, which returns results in the
|
|
457
|
-
* next page.</p>
|
|
458
|
-
* @public
|
|
459
|
-
*/
|
|
460
|
-
NextToken?: string | undefined;
|
|
461
|
-
}
|
|
462
|
-
/**
|
|
463
|
-
* @public
|
|
464
|
-
* @enum
|
|
465
|
-
*/
|
|
466
|
-
export declare const ScheduledBy: {
|
|
467
|
-
readonly CUSTOMER: "CUSTOMER";
|
|
468
|
-
readonly SYSTEM: "SYSTEM";
|
|
469
|
-
};
|
|
470
|
-
/**
|
|
471
|
-
* @public
|
|
472
|
-
*/
|
|
473
|
-
export type ScheduledBy = (typeof ScheduledBy)[keyof typeof ScheduledBy];
|
|
474
|
-
/**
|
|
475
|
-
* <p>Information about a scheduled configuration change for an OpenSearch Service domain.
|
|
476
|
-
* This actions can be a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service
|
|
477
|
-
* software update</a> or a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancement</a>.</p>
|
|
478
|
-
* @public
|
|
479
|
-
*/
|
|
480
|
-
export interface ScheduledAction {
|
|
481
|
-
/**
|
|
482
|
-
* <p>The unique identifier of the scheduled action.</p>
|
|
483
|
-
* @public
|
|
484
|
-
*/
|
|
485
|
-
Id: string | undefined;
|
|
486
|
-
/**
|
|
487
|
-
* <p>The type of action that will be taken on the domain.</p>
|
|
488
|
-
* @public
|
|
489
|
-
*/
|
|
490
|
-
Type: ActionType | undefined;
|
|
491
|
-
/**
|
|
492
|
-
* <p>The severity of the action.</p>
|
|
493
|
-
* @public
|
|
494
|
-
*/
|
|
495
|
-
Severity: ActionSeverity | undefined;
|
|
496
|
-
/**
|
|
497
|
-
* <p>The time when the change is scheduled to happen.</p>
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
ScheduledTime: number | undefined;
|
|
501
|
-
/**
|
|
502
|
-
* <p>A description of the action to be taken.</p>
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
Description?: string | undefined;
|
|
506
|
-
/**
|
|
507
|
-
* <p>Whether the action was scheduled manually (<code>CUSTOMER</code>, or by OpenSearch
|
|
508
|
-
* Service automatically (<code>SYSTEM</code>).</p>
|
|
509
|
-
* @public
|
|
510
|
-
*/
|
|
511
|
-
ScheduledBy?: ScheduledBy | undefined;
|
|
512
|
-
/**
|
|
513
|
-
* <p>The current status of the scheduled action.</p>
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
Status?: ActionStatus | undefined;
|
|
517
|
-
/**
|
|
518
|
-
* <p>Whether the action is required or optional.</p>
|
|
519
|
-
* @public
|
|
520
|
-
*/
|
|
521
|
-
Mandatory?: boolean | undefined;
|
|
522
|
-
/**
|
|
523
|
-
* <p>Whether or not the scheduled action is cancellable.</p>
|
|
524
|
-
* @public
|
|
525
|
-
*/
|
|
526
|
-
Cancellable?: boolean | undefined;
|
|
527
|
-
}
|
|
528
|
-
/**
|
|
529
|
-
* @public
|
|
530
|
-
*/
|
|
531
|
-
export interface ListScheduledActionsResponse {
|
|
532
|
-
/**
|
|
533
|
-
* <p>A list of actions that are scheduled for the domain.</p>
|
|
534
|
-
* @public
|
|
535
|
-
*/
|
|
536
|
-
ScheduledActions?: ScheduledAction[] | undefined;
|
|
537
|
-
/**
|
|
538
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
539
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
540
|
-
* again using the returned token to retrieve the next page.</p>
|
|
541
|
-
* @public
|
|
542
|
-
*/
|
|
543
|
-
NextToken?: string | undefined;
|
|
544
|
-
}
|
|
545
|
-
/**
|
|
546
|
-
* <p>Container for the parameters to the <code>ListTags</code> operation.</p>
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
export interface ListTagsRequest {
|
|
550
|
-
/**
|
|
551
|
-
* <p>Amazon Resource Name (ARN) for the domain, data source, or application to view tags
|
|
552
|
-
* for.</p>
|
|
553
|
-
* @public
|
|
554
|
-
*/
|
|
555
|
-
ARN: string | undefined;
|
|
556
|
-
}
|
|
557
|
-
/**
|
|
558
|
-
* <p>The results of a <code>ListTags</code> operation.</p>
|
|
559
|
-
* @public
|
|
560
|
-
*/
|
|
561
|
-
export interface ListTagsResponse {
|
|
562
|
-
/**
|
|
563
|
-
* <p>List of resource tags associated with the specified domain, data source, or
|
|
564
|
-
* application.</p>
|
|
565
|
-
* @public
|
|
566
|
-
*/
|
|
567
|
-
TagList?: Tag[] | undefined;
|
|
568
|
-
}
|
|
569
|
-
/**
|
|
570
|
-
* <p>Container for the request parameters to the <code>ListVersions</code>
|
|
571
|
-
* operation.</p>
|
|
572
|
-
* @public
|
|
573
|
-
*/
|
|
574
|
-
export interface ListVersionsRequest {
|
|
575
|
-
/**
|
|
576
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
577
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
578
|
-
* @public
|
|
579
|
-
*/
|
|
580
|
-
MaxResults?: number | undefined;
|
|
581
|
-
/**
|
|
582
|
-
* <p>If your initial <code>ListVersions</code> operation returns a <code>nextToken</code>,
|
|
583
|
-
* you can include the returned <code>nextToken</code> in subsequent
|
|
584
|
-
* <code>ListVersions</code> operations, which returns results in the next page.</p>
|
|
585
|
-
* @public
|
|
586
|
-
*/
|
|
587
|
-
NextToken?: string | undefined;
|
|
588
|
-
}
|
|
589
|
-
/**
|
|
590
|
-
* <p>Container for the parameters for response received from the <code>ListVersions</code>
|
|
591
|
-
* operation.</p>
|
|
592
|
-
* @public
|
|
593
|
-
*/
|
|
594
|
-
export interface ListVersionsResponse {
|
|
595
|
-
/**
|
|
596
|
-
* <p>A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service
|
|
597
|
-
* supports.</p>
|
|
598
|
-
* @public
|
|
599
|
-
*/
|
|
600
|
-
Versions?: string[] | undefined;
|
|
601
|
-
/**
|
|
602
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
603
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
604
|
-
* again using the returned token to retrieve the next page.</p>
|
|
605
|
-
* @public
|
|
606
|
-
*/
|
|
607
|
-
NextToken?: string | undefined;
|
|
608
|
-
}
|
|
609
|
-
/**
|
|
610
|
-
* @public
|
|
611
|
-
*/
|
|
612
|
-
export interface ListVpcEndpointAccessRequest {
|
|
613
|
-
/**
|
|
614
|
-
* <p>The name of the OpenSearch Service domain to retrieve access information for.</p>
|
|
615
|
-
* @public
|
|
616
|
-
*/
|
|
617
|
-
DomainName: string | undefined;
|
|
618
|
-
/**
|
|
619
|
-
* <p>If your initial <code>ListVpcEndpointAccess</code> operation returns a
|
|
620
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
621
|
-
* subsequent <code>ListVpcEndpointAccess</code> operations, which returns results in the
|
|
622
|
-
* next page.</p>
|
|
623
|
-
* @public
|
|
624
|
-
*/
|
|
625
|
-
NextToken?: string | undefined;
|
|
626
|
-
}
|
|
627
|
-
/**
|
|
628
|
-
* @public
|
|
629
|
-
*/
|
|
630
|
-
export interface ListVpcEndpointAccessResponse {
|
|
631
|
-
/**
|
|
632
|
-
* <p>A list of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM
|
|
633
|
-
* principals</a> that can currently access the domain.</p>
|
|
634
|
-
* @public
|
|
635
|
-
*/
|
|
636
|
-
AuthorizedPrincipalList: AuthorizedPrincipal[] | undefined;
|
|
637
|
-
/**
|
|
638
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
639
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
640
|
-
* again using the returned token to retrieve the next page.</p>
|
|
641
|
-
* @public
|
|
642
|
-
*/
|
|
643
|
-
NextToken: string | undefined;
|
|
644
|
-
}
|
|
645
|
-
/**
|
|
646
|
-
* @public
|
|
647
|
-
*/
|
|
648
|
-
export interface ListVpcEndpointsRequest {
|
|
649
|
-
/**
|
|
650
|
-
* <p>If your initial <code>ListVpcEndpoints</code> operation returns a
|
|
651
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
652
|
-
* subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next
|
|
653
|
-
* page.</p>
|
|
654
|
-
* @public
|
|
655
|
-
*/
|
|
656
|
-
NextToken?: string | undefined;
|
|
657
|
-
}
|
|
658
|
-
/**
|
|
659
|
-
* @public
|
|
660
|
-
*/
|
|
661
|
-
export interface ListVpcEndpointsResponse {
|
|
662
|
-
/**
|
|
663
|
-
* <p>Information about each endpoint.</p>
|
|
664
|
-
* @public
|
|
665
|
-
*/
|
|
666
|
-
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
667
|
-
/**
|
|
668
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
669
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
670
|
-
* again using the returned token to retrieve the next page.</p>
|
|
671
|
-
* @public
|
|
672
|
-
*/
|
|
673
|
-
NextToken: string | undefined;
|
|
674
|
-
}
|
|
675
|
-
/**
|
|
676
|
-
* @public
|
|
677
|
-
*/
|
|
678
|
-
export interface ListVpcEndpointsForDomainRequest {
|
|
679
|
-
/**
|
|
680
|
-
* <p>The name of the domain to list associated VPC endpoints for.</p>
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
DomainName: string | undefined;
|
|
684
|
-
/**
|
|
685
|
-
* <p>If your initial <code>ListEndpointsForDomain</code> operation returns a
|
|
686
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
687
|
-
* subsequent <code>ListEndpointsForDomain</code> operations, which returns results in the
|
|
688
|
-
* next page.</p>
|
|
689
|
-
* @public
|
|
690
|
-
*/
|
|
691
|
-
NextToken?: string | undefined;
|
|
692
|
-
}
|
|
693
|
-
/**
|
|
694
|
-
* @public
|
|
695
|
-
*/
|
|
696
|
-
export interface ListVpcEndpointsForDomainResponse {
|
|
697
|
-
/**
|
|
698
|
-
* <p>Information about each endpoint associated with the domain.</p>
|
|
699
|
-
* @public
|
|
700
|
-
*/
|
|
701
|
-
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
702
|
-
/**
|
|
703
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
704
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
705
|
-
* again using the returned token to retrieve the next page.</p>
|
|
706
|
-
* @public
|
|
707
|
-
*/
|
|
708
|
-
NextToken: string | undefined;
|
|
709
|
-
}
|
|
710
|
-
/**
|
|
711
|
-
* <p>Container for request parameters to the <code>PurchaseReservedInstanceOffering</code>
|
|
712
|
-
* operation.</p>
|
|
713
|
-
* @public
|
|
714
|
-
*/
|
|
715
|
-
export interface PurchaseReservedInstanceOfferingRequest {
|
|
716
|
-
/**
|
|
717
|
-
* <p>The ID of the Reserved Instance offering to purchase.</p>
|
|
718
|
-
* @public
|
|
719
|
-
*/
|
|
720
|
-
ReservedInstanceOfferingId: string | undefined;
|
|
721
|
-
/**
|
|
722
|
-
* <p>A customer-specified identifier to track this reservation.</p>
|
|
723
|
-
* @public
|
|
724
|
-
*/
|
|
725
|
-
ReservationName: string | undefined;
|
|
726
|
-
/**
|
|
727
|
-
* <p>The number of OpenSearch instances to reserve.</p>
|
|
728
|
-
* @public
|
|
729
|
-
*/
|
|
730
|
-
InstanceCount?: number | undefined;
|
|
731
|
-
}
|
|
732
|
-
/**
|
|
733
|
-
* <p>Represents the output of a <code>PurchaseReservedInstanceOffering</code>
|
|
734
|
-
* operation.</p>
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export interface PurchaseReservedInstanceOfferingResponse {
|
|
738
|
-
/**
|
|
739
|
-
* <p>The ID of the Reserved Instance offering that was purchased.</p>
|
|
740
|
-
* @public
|
|
741
|
-
*/
|
|
742
|
-
ReservedInstanceId?: string | undefined;
|
|
743
|
-
/**
|
|
744
|
-
* <p>The customer-specified identifier used to track this reservation.</p>
|
|
745
|
-
* @public
|
|
746
|
-
*/
|
|
747
|
-
ReservationName?: string | undefined;
|
|
748
|
-
}
|
|
749
|
-
/**
|
|
750
|
-
* @public
|
|
751
|
-
*/
|
|
752
|
-
export interface PutDefaultApplicationSettingRequest {
|
|
753
|
-
/**
|
|
754
|
-
* <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 </a> in
|
|
755
|
-
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
756
|
-
* more information. </p>
|
|
757
|
-
* @public
|
|
758
|
-
*/
|
|
759
|
-
applicationArn: string | undefined;
|
|
760
|
-
/**
|
|
761
|
-
* <p>Set to true to set the specified ARN as the default application. Set to false to clear
|
|
762
|
-
* the default application.</p>
|
|
763
|
-
* @public
|
|
764
|
-
*/
|
|
765
|
-
setAsDefault: boolean | undefined;
|
|
766
|
-
}
|
|
767
|
-
/**
|
|
768
|
-
* @public
|
|
769
|
-
*/
|
|
770
|
-
export interface PutDefaultApplicationSettingResponse {
|
|
771
|
-
/**
|
|
772
|
-
* <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 </a> in
|
|
773
|
-
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
774
|
-
* more information. </p>
|
|
775
|
-
* @public
|
|
776
|
-
*/
|
|
777
|
-
applicationArn?: string | undefined;
|
|
778
|
-
}
|
|
779
|
-
/**
|
|
780
|
-
* <p>Container for the request parameters to the <code>RejectInboundConnection</code>
|
|
781
|
-
* operation.</p>
|
|
782
|
-
* @public
|
|
783
|
-
*/
|
|
784
|
-
export interface RejectInboundConnectionRequest {
|
|
785
|
-
/**
|
|
786
|
-
* <p>The unique identifier of the inbound connection to reject.</p>
|
|
787
|
-
* @public
|
|
788
|
-
*/
|
|
789
|
-
ConnectionId: string | undefined;
|
|
790
|
-
}
|
|
791
|
-
/**
|
|
792
|
-
* <p>Represents the output of a <code>RejectInboundConnection</code> operation.</p>
|
|
793
|
-
* @public
|
|
794
|
-
*/
|
|
795
|
-
export interface RejectInboundConnectionResponse {
|
|
796
|
-
/**
|
|
797
|
-
* <p>Contains details about the rejected inbound connection.</p>
|
|
798
|
-
* @public
|
|
799
|
-
*/
|
|
800
|
-
Connection?: InboundConnection | undefined;
|
|
801
|
-
}
|
|
802
|
-
/**
|
|
803
|
-
* <p>Container for the request parameters to the <code>RemoveTags</code> operation.</p>
|
|
804
|
-
* @public
|
|
805
|
-
*/
|
|
806
|
-
export interface RemoveTagsRequest {
|
|
807
|
-
/**
|
|
808
|
-
* <p>The Amazon Resource Name (ARN) of the domain, data source, or application from which
|
|
809
|
-
* you want to delete the specified tags.</p>
|
|
810
|
-
* @public
|
|
811
|
-
*/
|
|
812
|
-
ARN: string | undefined;
|
|
813
|
-
/**
|
|
814
|
-
* <p>The list of tag keys to remove from the domain, data source, or application.</p>
|
|
815
|
-
* @public
|
|
816
|
-
*/
|
|
817
|
-
TagKeys: string[] | undefined;
|
|
818
|
-
}
|
|
819
|
-
/**
|
|
820
|
-
* @public
|
|
821
|
-
*/
|
|
822
|
-
export interface RevokeVpcEndpointAccessRequest {
|
|
823
|
-
/**
|
|
824
|
-
* <p>The name of the OpenSearch Service domain.</p>
|
|
825
|
-
* @public
|
|
826
|
-
*/
|
|
827
|
-
DomainName: string | undefined;
|
|
828
|
-
/**
|
|
829
|
-
* <p>The account ID to revoke access from.</p>
|
|
830
|
-
* @public
|
|
831
|
-
*/
|
|
832
|
-
Account?: string | undefined;
|
|
833
|
-
/**
|
|
834
|
-
* <p>The service SP to revoke access from.</p>
|
|
835
|
-
* @public
|
|
836
|
-
*/
|
|
837
|
-
Service?: AWSServicePrincipal | undefined;
|
|
838
|
-
}
|
|
839
|
-
/**
|
|
840
|
-
* @public
|
|
841
|
-
*/
|
|
842
|
-
export interface RevokeVpcEndpointAccessResponse {
|
|
843
|
-
}
|
|
844
|
-
/**
|
|
845
|
-
* <p>Container for the parameters to the <code>StartDomainMaintenance</code>
|
|
846
|
-
* operation.</p>
|
|
847
|
-
* @public
|
|
848
|
-
*/
|
|
849
|
-
export interface StartDomainMaintenanceRequest {
|
|
850
|
-
/**
|
|
851
|
-
* <p>The name of the domain.</p>
|
|
852
|
-
* @public
|
|
853
|
-
*/
|
|
854
|
-
DomainName: string | undefined;
|
|
855
|
-
/**
|
|
856
|
-
* <p>The name of the action.</p>
|
|
857
|
-
* @public
|
|
858
|
-
*/
|
|
859
|
-
Action: MaintenanceType | undefined;
|
|
860
|
-
/**
|
|
861
|
-
* <p>The ID of the data node.</p>
|
|
862
|
-
* @public
|
|
863
|
-
*/
|
|
864
|
-
NodeId?: string | undefined;
|
|
865
|
-
}
|
|
866
|
-
/**
|
|
867
|
-
* <p>The result of a <code>StartDomainMaintenance</code> request that information about the
|
|
868
|
-
* requested action. </p>
|
|
869
|
-
* @public
|
|
870
|
-
*/
|
|
871
|
-
export interface StartDomainMaintenanceResponse {
|
|
872
|
-
/**
|
|
873
|
-
* <p>The request ID of requested action.</p>
|
|
874
|
-
* @public
|
|
875
|
-
*/
|
|
876
|
-
MaintenanceId?: string | undefined;
|
|
877
|
-
}
|
|
878
|
-
/**
|
|
879
|
-
* @public
|
|
880
|
-
* @enum
|
|
881
|
-
*/
|
|
882
|
-
export declare const ScheduleAt: {
|
|
883
|
-
readonly NOW: "NOW";
|
|
884
|
-
readonly OFF_PEAK_WINDOW: "OFF_PEAK_WINDOW";
|
|
885
|
-
readonly TIMESTAMP: "TIMESTAMP";
|
|
886
|
-
};
|
|
887
|
-
/**
|
|
888
|
-
* @public
|
|
889
|
-
*/
|
|
890
|
-
export type ScheduleAt = (typeof ScheduleAt)[keyof typeof ScheduleAt];
|
|
891
|
-
/**
|
|
892
|
-
* <p>Container for the request parameters to the <code>StartServiceSoftwareUpdate</code>
|
|
893
|
-
* operation.</p>
|
|
894
|
-
* @public
|
|
895
|
-
*/
|
|
896
|
-
export interface StartServiceSoftwareUpdateRequest {
|
|
897
|
-
/**
|
|
898
|
-
* <p>The name of the domain that you want to update to the latest service software.</p>
|
|
899
|
-
* @public
|
|
900
|
-
*/
|
|
901
|
-
DomainName: string | undefined;
|
|
902
|
-
/**
|
|
903
|
-
* <p>When to start the service software update.</p>
|
|
904
|
-
* <ul>
|
|
905
|
-
* <li>
|
|
906
|
-
* <p>
|
|
907
|
-
* <code>NOW</code> - Immediately schedules the update to happen in the current
|
|
908
|
-
* hour if there's capacity available.</p>
|
|
909
|
-
* </li>
|
|
910
|
-
* <li>
|
|
911
|
-
* <p>
|
|
912
|
-
* <code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the
|
|
913
|
-
* update. If you specify this value, you must also provide a value for
|
|
914
|
-
* <code>DesiredStartTime</code>.</p>
|
|
915
|
-
* </li>
|
|
916
|
-
* <li>
|
|
917
|
-
* <p>
|
|
918
|
-
* <code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an
|
|
919
|
-
* upcoming off-peak window. There's no guarantee that the update will happen
|
|
920
|
-
* during the next immediate window. Depending on capacity, it might happen in
|
|
921
|
-
* subsequent days.</p>
|
|
922
|
-
* </li>
|
|
923
|
-
* </ul>
|
|
924
|
-
* <p>Default: <code>NOW</code> if you don't specify a value for
|
|
925
|
-
* <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p>
|
|
926
|
-
* @public
|
|
927
|
-
*/
|
|
928
|
-
ScheduleAt?: ScheduleAt | undefined;
|
|
929
|
-
/**
|
|
930
|
-
* <p>The Epoch timestamp when you want the service software update to start. You only need
|
|
931
|
-
* to specify this parameter if you set <code>ScheduleAt</code> to
|
|
932
|
-
* <code>TIMESTAMP</code>.</p>
|
|
933
|
-
* @public
|
|
934
|
-
*/
|
|
935
|
-
DesiredStartTime?: number | undefined;
|
|
936
|
-
}
|
|
937
|
-
/**
|
|
938
|
-
* <p>Represents the output of a <code>StartServiceSoftwareUpdate</code> operation. Contains
|
|
939
|
-
* the status of the update.</p>
|
|
940
|
-
* @public
|
|
941
|
-
*/
|
|
942
|
-
export interface StartServiceSoftwareUpdateResponse {
|
|
943
|
-
/**
|
|
944
|
-
* <p>The current status of the OpenSearch Service software update.</p>
|
|
945
|
-
* @public
|
|
946
|
-
*/
|
|
947
|
-
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
948
|
-
}
|
|
949
|
-
/**
|
|
950
|
-
* @public
|
|
951
|
-
*/
|
|
952
|
-
export interface UpdateApplicationRequest {
|
|
953
|
-
/**
|
|
954
|
-
* <p>The unique identifier for the OpenSearch application to be updated.</p>
|
|
955
|
-
* @public
|
|
956
|
-
*/
|
|
957
|
-
id: string | undefined;
|
|
958
|
-
/**
|
|
959
|
-
* <p>The data sources to associate with the OpenSearch application.</p>
|
|
960
|
-
* @public
|
|
961
|
-
*/
|
|
962
|
-
dataSources?: DataSource[] | undefined;
|
|
963
|
-
/**
|
|
964
|
-
* <p>The configuration settings to modify for the OpenSearch application.</p>
|
|
965
|
-
* @public
|
|
966
|
-
*/
|
|
967
|
-
appConfigs?: AppConfig[] | undefined;
|
|
968
|
-
}
|
|
969
|
-
/**
|
|
970
|
-
* @public
|
|
971
|
-
*/
|
|
972
|
-
export interface UpdateApplicationResponse {
|
|
973
|
-
/**
|
|
974
|
-
* <p>The unique identifier of the updated OpenSearch application.</p>
|
|
975
|
-
* @public
|
|
976
|
-
*/
|
|
977
|
-
id?: string | undefined;
|
|
978
|
-
/**
|
|
979
|
-
* <p>The name of the updated OpenSearch application.</p>
|
|
980
|
-
* @public
|
|
981
|
-
*/
|
|
982
|
-
name?: string | undefined;
|
|
983
|
-
/**
|
|
984
|
-
* <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 </a> in
|
|
985
|
-
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
986
|
-
* more information. </p>
|
|
987
|
-
* @public
|
|
988
|
-
*/
|
|
989
|
-
arn?: string | undefined;
|
|
990
|
-
/**
|
|
991
|
-
* <p>The data sources associated with the updated OpenSearch application.</p>
|
|
992
|
-
* @public
|
|
993
|
-
*/
|
|
994
|
-
dataSources?: DataSource[] | undefined;
|
|
995
|
-
/**
|
|
996
|
-
* <p>The IAM Identity Center configuration for the updated OpenSearch application.</p>
|
|
997
|
-
* @public
|
|
998
|
-
*/
|
|
999
|
-
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
1000
|
-
/**
|
|
1001
|
-
* <p>The configuration settings for the updated OpenSearch application.</p>
|
|
1002
|
-
* @public
|
|
1003
|
-
*/
|
|
1004
|
-
appConfigs?: AppConfig[] | undefined;
|
|
1005
|
-
/**
|
|
1006
|
-
* <p>The timestamp when the OpenSearch application was originally created.</p>
|
|
1007
|
-
* @public
|
|
1008
|
-
*/
|
|
1009
|
-
createdAt?: Date | undefined;
|
|
1010
|
-
/**
|
|
1011
|
-
* <p>The timestamp when the OpenSearch application was last updated.</p>
|
|
1012
|
-
* @public
|
|
1013
|
-
*/
|
|
1014
|
-
lastUpdatedAt?: Date | undefined;
|
|
1015
|
-
}
|
|
1016
|
-
/**
|
|
1017
|
-
* <p>Container for the parameters to the <code>UpdateDataSource</code> operation.</p>
|
|
1018
|
-
* @public
|
|
1019
|
-
*/
|
|
1020
|
-
export interface UpdateDataSourceRequest {
|
|
1021
|
-
/**
|
|
1022
|
-
* <p>The name of the domain.</p>
|
|
1023
|
-
* @public
|
|
1024
|
-
*/
|
|
1025
|
-
DomainName: string | undefined;
|
|
1026
|
-
/**
|
|
1027
|
-
* <p>The name of the data source to modify.</p>
|
|
1028
|
-
* @public
|
|
1029
|
-
*/
|
|
1030
|
-
Name: string | undefined;
|
|
1031
|
-
/**
|
|
1032
|
-
* <p>The type of data source.</p>
|
|
1033
|
-
* @public
|
|
1034
|
-
*/
|
|
1035
|
-
DataSourceType: DataSourceType | undefined;
|
|
1036
|
-
/**
|
|
1037
|
-
* <p>A new description of the data source.</p>
|
|
1038
|
-
* @public
|
|
1039
|
-
*/
|
|
1040
|
-
Description?: string | undefined;
|
|
1041
|
-
/**
|
|
1042
|
-
* <p>The status of the data source update.</p>
|
|
1043
|
-
* @public
|
|
1044
|
-
*/
|
|
1045
|
-
Status?: DataSourceStatus | undefined;
|
|
1046
|
-
}
|
|
1047
|
-
/**
|
|
1048
|
-
* <p>The result of an <code>UpdateDataSource</code> operation.</p>
|
|
1049
|
-
* @public
|
|
1050
|
-
*/
|
|
1051
|
-
export interface UpdateDataSourceResponse {
|
|
1052
|
-
/**
|
|
1053
|
-
* <p>A message associated with the updated data source.</p>
|
|
1054
|
-
* @public
|
|
1055
|
-
*/
|
|
1056
|
-
Message?: string | undefined;
|
|
1057
|
-
}
|
|
1058
|
-
/**
|
|
1059
|
-
* @public
|
|
1060
|
-
*/
|
|
1061
|
-
export interface UpdateDirectQueryDataSourceRequest {
|
|
1062
|
-
/**
|
|
1063
|
-
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
1064
|
-
* Service environment. </p>
|
|
1065
|
-
* @public
|
|
1066
|
-
*/
|
|
1067
|
-
DataSourceName: string | undefined;
|
|
1068
|
-
/**
|
|
1069
|
-
* <p> The supported Amazon Web Services service that you want to use as the source for
|
|
1070
|
-
* direct queries in OpenSearch Service. </p>
|
|
1071
|
-
* @public
|
|
1072
|
-
*/
|
|
1073
|
-
DataSourceType: DirectQueryDataSourceType | undefined;
|
|
1074
|
-
/**
|
|
1075
|
-
* <p> An optional text field for providing additional context and details about the data
|
|
1076
|
-
* source. </p>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
Description?: string | undefined;
|
|
1080
|
-
/**
|
|
1081
|
-
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
1082
|
-
* associated with the direct query data source. </p>
|
|
1083
|
-
* @public
|
|
1084
|
-
*/
|
|
1085
|
-
OpenSearchArns: string[] | undefined;
|
|
1086
|
-
}
|
|
1087
|
-
/**
|
|
1088
|
-
* @public
|
|
1089
|
-
*/
|
|
1090
|
-
export interface UpdateDirectQueryDataSourceResponse {
|
|
1091
|
-
/**
|
|
1092
|
-
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
1093
|
-
* @public
|
|
1094
|
-
*/
|
|
1095
|
-
DataSourceArn?: string | undefined;
|
|
1096
|
-
}
|
|
1097
|
-
/**
|
|
1098
|
-
* @public
|
|
1099
|
-
* @enum
|
|
1100
|
-
*/
|
|
1101
|
-
export declare const DryRunMode: {
|
|
1102
|
-
readonly Basic: "Basic";
|
|
1103
|
-
readonly Verbose: "Verbose";
|
|
1104
|
-
};
|
|
1105
|
-
/**
|
|
1106
|
-
* @public
|
|
1107
|
-
*/
|
|
1108
|
-
export type DryRunMode = (typeof DryRunMode)[keyof typeof DryRunMode];
|
|
1109
|
-
/**
|
|
1110
|
-
* <p>Container for the request parameters to the <code>UpdateDomain</code>
|
|
1111
|
-
* operation.</p>
|
|
1112
|
-
* @public
|
|
1113
|
-
*/
|
|
1114
|
-
export interface UpdateDomainConfigRequest {
|
|
1115
|
-
/**
|
|
1116
|
-
* <p>The name of the domain that you're updating.</p>
|
|
1117
|
-
* @public
|
|
1118
|
-
*/
|
|
1119
|
-
DomainName: string | undefined;
|
|
1120
|
-
/**
|
|
1121
|
-
* <p>Changes that you want to make to the cluster configuration, such as the instance type
|
|
1122
|
-
* and number of EC2 instances.</p>
|
|
1123
|
-
* @public
|
|
1124
|
-
*/
|
|
1125
|
-
ClusterConfig?: ClusterConfig | undefined;
|
|
1126
|
-
/**
|
|
1127
|
-
* <p>The type and size of the EBS volume to attach to instances in the domain.</p>
|
|
1128
|
-
* @public
|
|
1129
|
-
*/
|
|
1130
|
-
EBSOptions?: EBSOptions | undefined;
|
|
1131
|
-
/**
|
|
1132
|
-
* <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value
|
|
1133
|
-
* is <code>0</code> hours. </p>
|
|
1134
|
-
* @public
|
|
1135
|
-
*/
|
|
1136
|
-
SnapshotOptions?: SnapshotOptions | undefined;
|
|
1137
|
-
/**
|
|
1138
|
-
* <p>Options to specify the subnets and security groups for a VPC endpoint. For more
|
|
1139
|
-
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon
|
|
1140
|
-
* OpenSearch Service domains using a VPC</a>.</p>
|
|
1141
|
-
* @public
|
|
1142
|
-
*/
|
|
1143
|
-
VPCOptions?: VPCOptions | undefined;
|
|
1144
|
-
/**
|
|
1145
|
-
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch
|
|
1146
|
-
* Dashboards.</p>
|
|
1147
|
-
* @public
|
|
1148
|
-
*/
|
|
1149
|
-
CognitoOptions?: CognitoOptions | undefined;
|
|
1150
|
-
/**
|
|
1151
|
-
* <p>Key-value pairs to specify advanced configuration options. The following key-value
|
|
1152
|
-
* pairs are supported:</p>
|
|
1153
|
-
* <ul>
|
|
1154
|
-
* <li>
|
|
1155
|
-
* <p>
|
|
1156
|
-
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
1157
|
-
* the use of a string rather than a boolean. Specifies whether explicit references
|
|
1158
|
-
* to indexes are allowed inside the body of HTTP requests. If you want to
|
|
1159
|
-
* configure access policies for domain sub-resources, such as specific indexes and
|
|
1160
|
-
* domain APIs, you must disable this property. Default is true.</p>
|
|
1161
|
-
* </li>
|
|
1162
|
-
* <li>
|
|
1163
|
-
* <p>
|
|
1164
|
-
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
1165
|
-
* rather than a boolean. Specifies the percentage of heap space allocated to field
|
|
1166
|
-
* data. Default is unbounded.</p>
|
|
1167
|
-
* </li>
|
|
1168
|
-
* <li>
|
|
1169
|
-
* <p>
|
|
1170
|
-
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
1171
|
-
* string rather than a boolean. Specifies the maximum number of clauses allowed in
|
|
1172
|
-
* a Lucene boolean query. Default is 1,024. Queries with more than the permitted
|
|
1173
|
-
* number of clauses result in a <code>TooManyClauses</code> error.</p>
|
|
1174
|
-
* </li>
|
|
1175
|
-
* </ul>
|
|
1176
|
-
* <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>
|
|
1177
|
-
* @public
|
|
1178
|
-
*/
|
|
1179
|
-
AdvancedOptions?: Record<string, string> | undefined;
|
|
1180
|
-
/**
|
|
1181
|
-
* <p>Identity and Access Management (IAM) access policy as a JSON-formatted string.</p>
|
|
1182
|
-
* @public
|
|
1183
|
-
*/
|
|
1184
|
-
AccessPolicies?: string | undefined;
|
|
1185
|
-
/**
|
|
1186
|
-
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to
|
|
1187
|
-
* share domain resources across IPv4 and IPv6 address types, and is the recommended
|
|
1188
|
-
* option. If your IP address type is currently set to dual stack, you can't change it.
|
|
1189
|
-
* </p>
|
|
1190
|
-
* @public
|
|
1191
|
-
*/
|
|
1192
|
-
IPAddressType?: IPAddressType | undefined;
|
|
1193
|
-
/**
|
|
1194
|
-
* <p>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</p>
|
|
1195
|
-
* @public
|
|
1196
|
-
*/
|
|
1197
|
-
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
1198
|
-
/**
|
|
1199
|
-
* <p>Encryption at rest options for the domain.</p>
|
|
1200
|
-
* @public
|
|
1201
|
-
*/
|
|
1202
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
|
|
1203
|
-
/**
|
|
1204
|
-
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
1205
|
-
* traffic.</p>
|
|
1206
|
-
* @public
|
|
1207
|
-
*/
|
|
1208
|
-
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
1209
|
-
/**
|
|
1210
|
-
* <p>Node-to-node encryption options for the domain.</p>
|
|
1211
|
-
* @public
|
|
1212
|
-
*/
|
|
1213
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
1214
|
-
/**
|
|
1215
|
-
* <p>Options for fine-grained access control.</p>
|
|
1216
|
-
* @public
|
|
1217
|
-
*/
|
|
1218
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
1219
|
-
/**
|
|
1220
|
-
* <p>Configuration settings for enabling and managing IAM Identity Center.</p>
|
|
1221
|
-
* @public
|
|
1222
|
-
*/
|
|
1223
|
-
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
1224
|
-
/**
|
|
1225
|
-
* <p>Options for Auto-Tune.</p>
|
|
1226
|
-
* @public
|
|
1227
|
-
*/
|
|
1228
|
-
AutoTuneOptions?: AutoTuneOptions | undefined;
|
|
1229
|
-
/**
|
|
1230
|
-
* <p>This flag, when set to True, specifies whether the <code>UpdateDomain</code> request
|
|
1231
|
-
* should return the results of a dry run analysis without actually applying the change. A
|
|
1232
|
-
* dry run determines what type of deployment the update will cause.</p>
|
|
1233
|
-
* @public
|
|
1234
|
-
*/
|
|
1235
|
-
DryRun?: boolean | undefined;
|
|
1236
|
-
/**
|
|
1237
|
-
* <p>The type of dry run to perform.</p>
|
|
1238
|
-
* <ul>
|
|
1239
|
-
* <li>
|
|
1240
|
-
* <p>
|
|
1241
|
-
* <code>Basic</code> only returns the type of deployment (blue/green or dynamic)
|
|
1242
|
-
* that the update will cause.</p>
|
|
1243
|
-
* </li>
|
|
1244
|
-
* <li>
|
|
1245
|
-
* <p>
|
|
1246
|
-
* <code>Verbose</code> runs an additional check to validate the changes you're
|
|
1247
|
-
* making. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check">Validating a domain update</a>.</p>
|
|
1248
|
-
* </li>
|
|
1249
|
-
* </ul>
|
|
1250
|
-
* @public
|
|
1251
|
-
*/
|
|
1252
|
-
DryRunMode?: DryRunMode | undefined;
|
|
1253
|
-
/**
|
|
1254
|
-
* <p>Off-peak window options for the domain.</p>
|
|
1255
|
-
* @public
|
|
1256
|
-
*/
|
|
1257
|
-
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
1258
|
-
/**
|
|
1259
|
-
* <p>Service software update options for the domain.</p>
|
|
1260
|
-
* @public
|
|
1261
|
-
*/
|
|
1262
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
|
|
1263
|
-
/**
|
|
1264
|
-
* <p>Options for all machine learning features for the specified domain.</p>
|
|
1265
|
-
* @public
|
|
1266
|
-
*/
|
|
1267
|
-
AIMLOptions?: AIMLOptionsInput | undefined;
|
|
1268
|
-
}
|
|
1269
|
-
/**
|
|
1270
|
-
* <p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain
|
|
1271
|
-
* being updated.</p>
|
|
1272
|
-
* @public
|
|
1273
|
-
*/
|
|
1274
|
-
export interface UpdateDomainConfigResponse {
|
|
1275
|
-
/**
|
|
1276
|
-
* <p>The status of the updated domain.</p>
|
|
1277
|
-
* @public
|
|
1278
|
-
*/
|
|
1279
|
-
DomainConfig: DomainConfig | undefined;
|
|
1280
|
-
/**
|
|
1281
|
-
* <p>Results of the dry run performed in the update domain request.</p>
|
|
1282
|
-
* @public
|
|
1283
|
-
*/
|
|
1284
|
-
DryRunResults?: DryRunResults | undefined;
|
|
1285
|
-
/**
|
|
1286
|
-
* <p>The status of the dry run being performed on the domain, if any.</p>
|
|
1287
|
-
* @public
|
|
1288
|
-
*/
|
|
1289
|
-
DryRunProgressStatus?: DryRunProgressStatus | undefined;
|
|
1290
|
-
}
|
|
1291
|
-
/**
|
|
1292
|
-
* @public
|
|
1293
|
-
*/
|
|
1294
|
-
export interface UpdateIndexRequest {
|
|
1295
|
-
/**
|
|
1296
|
-
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
1297
|
-
* owned by an account within an Amazon Web Services Region.</p>
|
|
1298
|
-
* @public
|
|
1299
|
-
*/
|
|
1300
|
-
DomainName: string | undefined;
|
|
1301
|
-
/**
|
|
1302
|
-
* <p>The name of the index to update.</p>
|
|
1303
|
-
* @public
|
|
1304
|
-
*/
|
|
1305
|
-
IndexName: string | undefined;
|
|
1306
|
-
/**
|
|
1307
|
-
* <p>The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.</p>
|
|
1308
|
-
* @public
|
|
1309
|
-
*/
|
|
1310
|
-
IndexSchema: __DocumentType | undefined;
|
|
1311
|
-
}
|
|
1312
|
-
/**
|
|
1313
|
-
* @public
|
|
1314
|
-
*/
|
|
1315
|
-
export interface UpdateIndexResponse {
|
|
1316
|
-
/**
|
|
1317
|
-
* <p>The status of the index update operation.</p>
|
|
1318
|
-
* @public
|
|
1319
|
-
*/
|
|
1320
|
-
Status: IndexStatus | undefined;
|
|
1321
|
-
}
|
|
1322
|
-
/**
|
|
1323
|
-
* <p>Container for request parameters to the <code>UpdatePackage</code> operation.</p>
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
export interface UpdatePackageRequest {
|
|
1327
|
-
/**
|
|
1328
|
-
* <p>The unique identifier for the package.</p>
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
PackageID: string | undefined;
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>Amazon S3 bucket and key for the package.</p>
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
PackageSource: PackageSource | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* <p>A new description of the package.</p>
|
|
1339
|
-
* @public
|
|
1340
|
-
*/
|
|
1341
|
-
PackageDescription?: string | undefined;
|
|
1342
|
-
/**
|
|
1343
|
-
* <p>Commit message for the updated file, which is shown as part of
|
|
1344
|
-
* <code>GetPackageVersionHistoryResponse</code>.</p>
|
|
1345
|
-
* @public
|
|
1346
|
-
*/
|
|
1347
|
-
CommitMessage?: string | undefined;
|
|
1348
|
-
/**
|
|
1349
|
-
* <p>The updated configuration details for a package.</p>
|
|
1350
|
-
* @public
|
|
1351
|
-
*/
|
|
1352
|
-
PackageConfiguration?: PackageConfiguration | undefined;
|
|
1353
|
-
/**
|
|
1354
|
-
* <p>Encryption options for a package.</p>
|
|
1355
|
-
* @public
|
|
1356
|
-
*/
|
|
1357
|
-
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
1358
|
-
}
|
|
1359
|
-
/**
|
|
1360
|
-
* <p>Container for the response returned by the <code>UpdatePackage</code>
|
|
1361
|
-
* operation.</p>
|
|
1362
|
-
* @public
|
|
1363
|
-
*/
|
|
1364
|
-
export interface UpdatePackageResponse {
|
|
1365
|
-
/**
|
|
1366
|
-
* <p>Information about a package.</p>
|
|
1367
|
-
* @public
|
|
1368
|
-
*/
|
|
1369
|
-
PackageDetails?: PackageDetails | undefined;
|
|
1370
|
-
}
|
|
1371
|
-
/**
|
|
1372
|
-
* @public
|
|
1373
|
-
* @enum
|
|
1374
|
-
*/
|
|
1375
|
-
export declare const PackageScopeOperationEnum: {
|
|
1376
|
-
readonly ADD: "ADD";
|
|
1377
|
-
readonly OVERRIDE: "OVERRIDE";
|
|
1378
|
-
readonly REMOVE: "REMOVE";
|
|
1379
|
-
};
|
|
1380
|
-
/**
|
|
1381
|
-
* @public
|
|
1382
|
-
*/
|
|
1383
|
-
export type PackageScopeOperationEnum = (typeof PackageScopeOperationEnum)[keyof typeof PackageScopeOperationEnum];
|
|
1384
|
-
/**
|
|
1385
|
-
* @public
|
|
1386
|
-
*/
|
|
1387
|
-
export interface UpdatePackageScopeRequest {
|
|
1388
|
-
/**
|
|
1389
|
-
* <p>ID of the package whose scope is being updated.</p>
|
|
1390
|
-
* @public
|
|
1391
|
-
*/
|
|
1392
|
-
PackageID: string | undefined;
|
|
1393
|
-
/**
|
|
1394
|
-
* <p> The operation to perform on the package scope (e.g., add/remove/override
|
|
1395
|
-
* users).</p>
|
|
1396
|
-
* @public
|
|
1397
|
-
*/
|
|
1398
|
-
Operation: PackageScopeOperationEnum | undefined;
|
|
1399
|
-
/**
|
|
1400
|
-
* <p> List of users to be added or removed from the package scope.</p>
|
|
1401
|
-
* @public
|
|
1402
|
-
*/
|
|
1403
|
-
PackageUserList: string[] | undefined;
|
|
1404
|
-
}
|
|
1405
|
-
/**
|
|
1406
|
-
* @public
|
|
1407
|
-
*/
|
|
1408
|
-
export interface UpdatePackageScopeResponse {
|
|
1409
|
-
/**
|
|
1410
|
-
* <p> ID of the package whose scope was updated.</p>
|
|
1411
|
-
* @public
|
|
1412
|
-
*/
|
|
1413
|
-
PackageID?: string | undefined;
|
|
1414
|
-
/**
|
|
1415
|
-
* <p>The operation that was performed on the package scope.</p>
|
|
1416
|
-
* @public
|
|
1417
|
-
*/
|
|
1418
|
-
Operation?: PackageScopeOperationEnum | undefined;
|
|
1419
|
-
/**
|
|
1420
|
-
* <p> List of users who have access to the package after the scope update.</p>
|
|
1421
|
-
* @public
|
|
1422
|
-
*/
|
|
1423
|
-
PackageUserList?: string[] | undefined;
|
|
1424
|
-
}
|
|
1425
|
-
/**
|
|
1426
|
-
* <p>An exception for attempting to schedule a domain action during an unavailable time slot.</p>
|
|
1427
|
-
* @public
|
|
1428
|
-
*/
|
|
1429
|
-
export declare class SlotNotAvailableException extends __BaseException {
|
|
1430
|
-
readonly name: "SlotNotAvailableException";
|
|
1431
|
-
readonly $fault: "client";
|
|
1432
|
-
/**
|
|
1433
|
-
* <p>Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.</p>
|
|
1434
|
-
* @public
|
|
1435
|
-
*/
|
|
1436
|
-
SlotSuggestions?: number[] | undefined;
|
|
1437
|
-
/**
|
|
1438
|
-
* @internal
|
|
1439
|
-
*/
|
|
1440
|
-
constructor(opts: __ExceptionOptionType<SlotNotAvailableException, __BaseException>);
|
|
1441
|
-
}
|
|
1442
|
-
/**
|
|
1443
|
-
* @public
|
|
1444
|
-
*/
|
|
1445
|
-
export interface UpdateScheduledActionRequest {
|
|
1446
|
-
/**
|
|
1447
|
-
* <p>The name of the domain to reschedule an action for.</p>
|
|
1448
|
-
* @public
|
|
1449
|
-
*/
|
|
1450
|
-
DomainName: string | undefined;
|
|
1451
|
-
/**
|
|
1452
|
-
* <p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
|
|
1453
|
-
* @public
|
|
1454
|
-
*/
|
|
1455
|
-
ActionID: string | undefined;
|
|
1456
|
-
/**
|
|
1457
|
-
* <p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>,
|
|
1458
|
-
* <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve
|
|
1459
|
-
* this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
|
|
1460
|
-
* @public
|
|
1461
|
-
*/
|
|
1462
|
-
ActionType: ActionType | undefined;
|
|
1463
|
-
/**
|
|
1464
|
-
* <p>When to schedule the action.</p>
|
|
1465
|
-
* <ul>
|
|
1466
|
-
* <li>
|
|
1467
|
-
* <p>
|
|
1468
|
-
* <code>NOW</code> - Immediately schedules the update to happen in the current
|
|
1469
|
-
* hour if there's capacity available.</p>
|
|
1470
|
-
* </li>
|
|
1471
|
-
* <li>
|
|
1472
|
-
* <p>
|
|
1473
|
-
* <code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the
|
|
1474
|
-
* update. If you specify this value, you must also provide a value for
|
|
1475
|
-
* <code>DesiredStartTime</code>.</p>
|
|
1476
|
-
* </li>
|
|
1477
|
-
* <li>
|
|
1478
|
-
* <p>
|
|
1479
|
-
* <code>OFF_PEAK_WINDOW</code> - Marks the action to be picked up during an
|
|
1480
|
-
* upcoming off-peak window. There's no guarantee that the change will be
|
|
1481
|
-
* implemented during the next immediate window. Depending on capacity, it might
|
|
1482
|
-
* happen in subsequent days.</p>
|
|
1483
|
-
* </li>
|
|
1484
|
-
* </ul>
|
|
1485
|
-
* @public
|
|
1486
|
-
*/
|
|
1487
|
-
ScheduleAt: ScheduleAt | undefined;
|
|
1488
|
-
/**
|
|
1489
|
-
* <p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify
|
|
1490
|
-
* this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
|
|
1491
|
-
* @public
|
|
1492
|
-
*/
|
|
1493
|
-
DesiredStartTime?: number | undefined;
|
|
1494
|
-
}
|
|
1495
|
-
/**
|
|
1496
|
-
* @public
|
|
1497
|
-
*/
|
|
1498
|
-
export interface UpdateScheduledActionResponse {
|
|
1499
|
-
/**
|
|
1500
|
-
* <p>Information about the rescheduled action.</p>
|
|
1501
|
-
* @public
|
|
1502
|
-
*/
|
|
1503
|
-
ScheduledAction?: ScheduledAction | undefined;
|
|
1504
|
-
}
|
|
1505
|
-
/**
|
|
1506
|
-
* @public
|
|
1507
|
-
*/
|
|
1508
|
-
export interface UpdateVpcEndpointRequest {
|
|
1509
|
-
/**
|
|
1510
|
-
* <p>The unique identifier of the endpoint.</p>
|
|
1511
|
-
* @public
|
|
1512
|
-
*/
|
|
1513
|
-
VpcEndpointId: string | undefined;
|
|
1514
|
-
/**
|
|
1515
|
-
* <p>The security groups and/or subnets to add, remove, or modify.</p>
|
|
1516
|
-
* @public
|
|
1517
|
-
*/
|
|
1518
|
-
VpcOptions: VPCOptions | undefined;
|
|
1519
|
-
}
|
|
1520
|
-
/**
|
|
1521
|
-
* @public
|
|
1522
|
-
*/
|
|
1523
|
-
export interface UpdateVpcEndpointResponse {
|
|
1524
|
-
/**
|
|
1525
|
-
* <p>The endpoint to be updated.</p>
|
|
1526
|
-
* @public
|
|
1527
|
-
*/
|
|
1528
|
-
VpcEndpoint: VpcEndpoint | undefined;
|
|
1529
|
-
}
|
|
1530
|
-
/**
|
|
1531
|
-
* <p>Container for the request parameters to the <code>UpgradeDomain</code>
|
|
1532
|
-
* operation.</p>
|
|
1533
|
-
* @public
|
|
1534
|
-
*/
|
|
1535
|
-
export interface UpgradeDomainRequest {
|
|
1536
|
-
/**
|
|
1537
|
-
* <p>Name of the OpenSearch Service domain that you want to upgrade.</p>
|
|
1538
|
-
* @public
|
|
1539
|
-
*/
|
|
1540
|
-
DomainName: string | undefined;
|
|
1541
|
-
/**
|
|
1542
|
-
* <p>OpenSearch or Elasticsearch version to which you want to upgrade, in the format
|
|
1543
|
-
* Opensearch_X.Y or Elasticsearch_X.Y.</p>
|
|
1544
|
-
* @public
|
|
1545
|
-
*/
|
|
1546
|
-
TargetVersion: string | undefined;
|
|
1547
|
-
/**
|
|
1548
|
-
* <p>When true, indicates that an upgrade eligibility check needs to be performed. Does not
|
|
1549
|
-
* actually perform the upgrade.</p>
|
|
1550
|
-
* @public
|
|
1551
|
-
*/
|
|
1552
|
-
PerformCheckOnly?: boolean | undefined;
|
|
1553
|
-
/**
|
|
1554
|
-
* <p>Only supports the <code>override_main_response_version</code> parameter and not other
|
|
1555
|
-
* advanced options. You can only include this option when upgrading to an OpenSearch
|
|
1556
|
-
* version. Specifies whether the domain reports its version as 7.10 so that it continues
|
|
1557
|
-
* to work with Elasticsearch OSS clients and plugins.</p>
|
|
1558
|
-
* @public
|
|
1559
|
-
*/
|
|
1560
|
-
AdvancedOptions?: Record<string, string> | undefined;
|
|
1561
|
-
}
|
|
1562
|
-
/**
|
|
1563
|
-
* <p>Container for the response returned by <code>UpgradeDomain</code> operation.</p>
|
|
1564
|
-
* @public
|
|
1565
|
-
*/
|
|
1566
|
-
export interface UpgradeDomainResponse {
|
|
1567
|
-
/**
|
|
1568
|
-
* <p>The unique identifier of the domain upgrade.</p>
|
|
1569
|
-
* @public
|
|
1570
|
-
*/
|
|
1571
|
-
UpgradeId?: string | undefined;
|
|
1572
|
-
/**
|
|
1573
|
-
* <p>The name of the domain that was upgraded.</p>
|
|
1574
|
-
* @public
|
|
1575
|
-
*/
|
|
1576
|
-
DomainName?: string | undefined;
|
|
1577
|
-
/**
|
|
1578
|
-
* <p>OpenSearch or Elasticsearch version that the domain was upgraded to.</p>
|
|
1579
|
-
* @public
|
|
1580
|
-
*/
|
|
1581
|
-
TargetVersion?: string | undefined;
|
|
1582
|
-
/**
|
|
1583
|
-
* <p>When true, indicates that an upgrade eligibility check was performed.</p>
|
|
1584
|
-
* @public
|
|
1585
|
-
*/
|
|
1586
|
-
PerformCheckOnly?: boolean | undefined;
|
|
1587
|
-
/**
|
|
1588
|
-
* <p>The advanced options configuration for the domain.</p>
|
|
1589
|
-
* @public
|
|
1590
|
-
*/
|
|
1591
|
-
AdvancedOptions?: Record<string, string> | undefined;
|
|
1592
|
-
/**
|
|
1593
|
-
* <p>Container for information about a configuration change happening on a domain.</p>
|
|
1594
|
-
* @public
|
|
1595
|
-
*/
|
|
1596
|
-
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
1597
|
-
}
|