UNPKG

74 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class ES extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ES.Types.ClientConfiguration)
13 config: Config & ES.Types.ClientConfiguration;
14 /**
15 * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
16 */
17 addTags(params: ES.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18 /**
19 * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
20 */
21 addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22 /**
23 * Associates a package with an Amazon ES domain.
24 */
25 associatePackage(params: ES.Types.AssociatePackageRequest, callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
26 /**
27 * Associates a package with an Amazon ES domain.
28 */
29 associatePackage(callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
30 /**
31 * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
32 */
33 cancelElasticsearchServiceSoftwareUpdate(params: ES.Types.CancelElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
34 /**
35 * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
36 */
37 cancelElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
38 /**
39 * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
40 */
41 createElasticsearchDomain(params: ES.Types.CreateElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
42 /**
43 * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
44 */
45 createElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
46 /**
47 * Create a package for use with Amazon ES domains.
48 */
49 createPackage(params: ES.Types.CreatePackageRequest, callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
50 /**
51 * Create a package for use with Amazon ES domains.
52 */
53 createPackage(callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
54 /**
55 * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
56 */
57 deleteElasticsearchDomain(params: ES.Types.DeleteElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
58 /**
59 * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
60 */
61 deleteElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
62 /**
63 * Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
64 */
65 deleteElasticsearchServiceRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * Delete the package.
68 */
69 deletePackage(params: ES.Types.DeletePackageRequest, callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
70 /**
71 * Delete the package.
72 */
73 deletePackage(callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
74 /**
75 * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
76 */
77 describeElasticsearchDomain(params: ES.Types.DescribeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
78 /**
79 * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
80 */
81 describeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
82 /**
83 * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
84 */
85 describeElasticsearchDomainConfig(params: ES.Types.DescribeElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
86 /**
87 * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
88 */
89 describeElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
90 /**
91 * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
92 */
93 describeElasticsearchDomains(params: ES.Types.DescribeElasticsearchDomainsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
94 /**
95 * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
96 */
97 describeElasticsearchDomains(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
98 /**
99 * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
100 */
101 describeElasticsearchInstanceTypeLimits(params: ES.Types.DescribeElasticsearchInstanceTypeLimitsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
102 /**
103 * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
104 */
105 describeElasticsearchInstanceTypeLimits(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
106 /**
107 * Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
108 */
109 describePackages(params: ES.Types.DescribePackagesRequest, callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
110 /**
111 * Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
112 */
113 describePackages(callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
114 /**
115 * Lists available reserved Elasticsearch instance offerings.
116 */
117 describeReservedElasticsearchInstanceOfferings(params: ES.Types.DescribeReservedElasticsearchInstanceOfferingsRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
118 /**
119 * Lists available reserved Elasticsearch instance offerings.
120 */
121 describeReservedElasticsearchInstanceOfferings(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
122 /**
123 * Returns information about reserved Elasticsearch instances for this account.
124 */
125 describeReservedElasticsearchInstances(params: ES.Types.DescribeReservedElasticsearchInstancesRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
126 /**
127 * Returns information about reserved Elasticsearch instances for this account.
128 */
129 describeReservedElasticsearchInstances(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
130 /**
131 * Dissociates a package from the Amazon ES domain.
132 */
133 dissociatePackage(params: ES.Types.DissociatePackageRequest, callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
134 /**
135 * Dissociates a package from the Amazon ES domain.
136 */
137 dissociatePackage(callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
138 /**
139 * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
140 */
141 getCompatibleElasticsearchVersions(params: ES.Types.GetCompatibleElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
142 /**
143 * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
144 */
145 getCompatibleElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
146 /**
147 * Retrieves the complete history of the last 10 upgrades that were performed on the domain.
148 */
149 getUpgradeHistory(params: ES.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
150 /**
151 * Retrieves the complete history of the last 10 upgrades that were performed on the domain.
152 */
153 getUpgradeHistory(callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
154 /**
155 * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
156 */
157 getUpgradeStatus(params: ES.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
158 /**
159 * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
160 */
161 getUpgradeStatus(callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
162 /**
163 * Returns the name of all Elasticsearch domains owned by the current user's account.
164 */
165 listDomainNames(callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
166 /**
167 * Lists all Amazon ES domains associated with the package.
168 */
169 listDomainsForPackage(params: ES.Types.ListDomainsForPackageRequest, callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
170 /**
171 * Lists all Amazon ES domains associated with the package.
172 */
173 listDomainsForPackage(callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
174 /**
175 * List all Elasticsearch instance types that are supported for given ElasticsearchVersion
176 */
177 listElasticsearchInstanceTypes(params: ES.Types.ListElasticsearchInstanceTypesRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
178 /**
179 * List all Elasticsearch instance types that are supported for given ElasticsearchVersion
180 */
181 listElasticsearchInstanceTypes(callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
182 /**
183 * List all supported Elasticsearch versions
184 */
185 listElasticsearchVersions(params: ES.Types.ListElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
186 /**
187 * List all supported Elasticsearch versions
188 */
189 listElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
190 /**
191 * Lists all packages associated with the Amazon ES domain.
192 */
193 listPackagesForDomain(params: ES.Types.ListPackagesForDomainRequest, callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
194 /**
195 * Lists all packages associated with the Amazon ES domain.
196 */
197 listPackagesForDomain(callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
198 /**
199 * Returns all tags for the given Elasticsearch domain.
200 */
201 listTags(params: ES.Types.ListTagsRequest, callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
202 /**
203 * Returns all tags for the given Elasticsearch domain.
204 */
205 listTags(callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
206 /**
207 * Allows you to purchase reserved Elasticsearch instances.
208 */
209 purchaseReservedElasticsearchInstanceOffering(params: ES.Types.PurchaseReservedElasticsearchInstanceOfferingRequest, callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
210 /**
211 * Allows you to purchase reserved Elasticsearch instances.
212 */
213 purchaseReservedElasticsearchInstanceOffering(callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
214 /**
215 * Removes the specified set of tags from the specified Elasticsearch domain.
216 */
217 removeTags(params: ES.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218 /**
219 * Removes the specified set of tags from the specified Elasticsearch domain.
220 */
221 removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222 /**
223 * Schedules a service software update for an Amazon ES domain.
224 */
225 startElasticsearchServiceSoftwareUpdate(params: ES.Types.StartElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
226 /**
227 * Schedules a service software update for an Amazon ES domain.
228 */
229 startElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
230 /**
231 * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
232 */
233 updateElasticsearchDomainConfig(params: ES.Types.UpdateElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
234 /**
235 * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
236 */
237 updateElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
238 /**
239 * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
240 */
241 upgradeElasticsearchDomain(params: ES.Types.UpgradeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
242 /**
243 * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
244 */
245 upgradeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
246}
247declare namespace ES {
248 export type ARN = string;
249 export interface AccessPoliciesStatus {
250 /**
251 * The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.
252 */
253 Options: PolicyDocument;
254 /**
255 * The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
256 */
257 Status: OptionStatus;
258 }
259 export interface AddTagsRequest {
260 /**
261 * Specify the ARN for which you want to add the tags.
262 */
263 ARN: ARN;
264 /**
265 * List of Tag that need to be added for the Elasticsearch domain.
266 */
267 TagList: TagList;
268 }
269 export interface AdditionalLimit {
270 /**
271 * Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them.
272 */
273 LimitName?: LimitName;
274 /**
275 * Value for given AdditionalLimit$LimitName .
276 */
277 LimitValues?: LimitValueList;
278 }
279 export type AdditionalLimitList = AdditionalLimit[];
280 export type AdvancedOptions = {[key: string]: String};
281 export interface AdvancedOptionsStatus {
282 /**
283 * Specifies the status of advanced options for the specified Elasticsearch domain.
284 */
285 Options: AdvancedOptions;
286 /**
287 * Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
288 */
289 Status: OptionStatus;
290 }
291 export interface AdvancedSecurityOptions {
292 /**
293 * True if advanced security is enabled.
294 */
295 Enabled?: Boolean;
296 /**
297 * True if the internal user database is enabled.
298 */
299 InternalUserDatabaseEnabled?: Boolean;
300 }
301 export interface AdvancedSecurityOptionsInput {
302 /**
303 * True if advanced security is enabled.
304 */
305 Enabled?: Boolean;
306 /**
307 * True if the internal user database is enabled.
308 */
309 InternalUserDatabaseEnabled?: Boolean;
310 /**
311 * Credentials for the master user: username and password, ARN, or both.
312 */
313 MasterUserOptions?: MasterUserOptions;
314 }
315 export interface AdvancedSecurityOptionsStatus {
316 /**
317 * Specifies advanced security options for the specified Elasticsearch domain.
318 */
319 Options: AdvancedSecurityOptions;
320 /**
321 * Status of the advanced security options for the specified Elasticsearch domain.
322 */
323 Status: OptionStatus;
324 }
325 export interface AssociatePackageRequest {
326 /**
327 * Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
328 */
329 PackageID: PackageID;
330 /**
331 * Name of the domain that you want to associate the package with.
332 */
333 DomainName: DomainName;
334 }
335 export interface AssociatePackageResponse {
336 /**
337 * DomainPackageDetails
338 */
339 DomainPackageDetails?: DomainPackageDetails;
340 }
341 export type Boolean = boolean;
342 export interface CancelElasticsearchServiceSoftwareUpdateRequest {
343 /**
344 * The name of the domain that you want to stop the latest service software update on.
345 */
346 DomainName: DomainName;
347 }
348 export interface CancelElasticsearchServiceSoftwareUpdateResponse {
349 /**
350 * The current status of the Elasticsearch service software update.
351 */
352 ServiceSoftwareOptions?: ServiceSoftwareOptions;
353 }
354 export type CloudWatchLogsLogGroupArn = string;
355 export interface CognitoOptions {
356 /**
357 * Specifies the option to enable Cognito for Kibana authentication.
358 */
359 Enabled?: Boolean;
360 /**
361 * Specifies the Cognito user pool ID for Kibana authentication.
362 */
363 UserPoolId?: UserPoolId;
364 /**
365 * Specifies the Cognito identity pool ID for Kibana authentication.
366 */
367 IdentityPoolId?: IdentityPoolId;
368 /**
369 * Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
370 */
371 RoleArn?: RoleArn;
372 }
373 export interface CognitoOptionsStatus {
374 /**
375 * Specifies the Cognito options for the specified Elasticsearch domain.
376 */
377 Options: CognitoOptions;
378 /**
379 * Specifies the status of the Cognito options for the specified Elasticsearch domain.
380 */
381 Status: OptionStatus;
382 }
383 export type CompatibleElasticsearchVersionsList = CompatibleVersionsMap[];
384 export interface CompatibleVersionsMap {
385 /**
386 * The current version of Elasticsearch on which a domain is.
387 */
388 SourceVersion?: ElasticsearchVersionString;
389 TargetVersions?: ElasticsearchVersionList;
390 }
391 export interface CreateElasticsearchDomainRequest {
392 /**
393 * The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
394 */
395 DomainName: DomainName;
396 /**
397 * String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
398 */
399 ElasticsearchVersion?: ElasticsearchVersionString;
400 /**
401 * Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
402 */
403 ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
404 /**
405 * Options to enable, disable and specify the type and size of EBS storage volumes.
406 */
407 EBSOptions?: EBSOptions;
408 /**
409 * IAM access policy as a JSON-formatted string.
410 */
411 AccessPolicies?: PolicyDocument;
412 /**
413 * Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
414 */
415 SnapshotOptions?: SnapshotOptions;
416 /**
417 * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
418 */
419 VPCOptions?: VPCOptions;
420 /**
421 * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
422 */
423 CognitoOptions?: CognitoOptions;
424 /**
425 * Specifies the Encryption At Rest Options.
426 */
427 EncryptionAtRestOptions?: EncryptionAtRestOptions;
428 /**
429 * Specifies the NodeToNodeEncryptionOptions.
430 */
431 NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
432 /**
433 * Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
434 */
435 AdvancedOptions?: AdvancedOptions;
436 /**
437 * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
438 */
439 LogPublishingOptions?: LogPublishingOptions;
440 /**
441 * Options to specify configuration that will be applied to the domain endpoint.
442 */
443 DomainEndpointOptions?: DomainEndpointOptions;
444 /**
445 * Specifies advanced security options.
446 */
447 AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
448 }
449 export interface CreateElasticsearchDomainResponse {
450 /**
451 * The status of the newly created Elasticsearch domain.
452 */
453 DomainStatus?: ElasticsearchDomainStatus;
454 }
455 export interface CreatePackageRequest {
456 /**
457 * Unique identifier for the package.
458 */
459 PackageName: PackageName;
460 /**
461 * Type of package. Currently supports only TXT-DICTIONARY.
462 */
463 PackageType: PackageType;
464 /**
465 * Description of the package.
466 */
467 PackageDescription?: PackageDescription;
468 /**
469 * The customer S3 location PackageSource for importing the package.
470 */
471 PackageSource: PackageSource;
472 }
473 export interface CreatePackageResponse {
474 /**
475 * Information about the package PackageDetails.
476 */
477 PackageDetails?: PackageDetails;
478 }
479 export type CreatedAt = Date;
480 export interface DeleteElasticsearchDomainRequest {
481 /**
482 * The name of the Elasticsearch domain that you want to permanently delete.
483 */
484 DomainName: DomainName;
485 }
486 export interface DeleteElasticsearchDomainResponse {
487 /**
488 * The status of the Elasticsearch domain being deleted.
489 */
490 DomainStatus?: ElasticsearchDomainStatus;
491 }
492 export interface DeletePackageRequest {
493 /**
494 * Internal ID of the package that you want to delete. Use DescribePackages to find this value.
495 */
496 PackageID: PackageID;
497 }
498 export interface DeletePackageResponse {
499 /**
500 * PackageDetails
501 */
502 PackageDetails?: PackageDetails;
503 }
504 export type DeploymentCloseDateTimeStamp = Date;
505 export type DeploymentStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE"|string;
506 export interface DescribeElasticsearchDomainConfigRequest {
507 /**
508 * The Elasticsearch domain that you want to get information about.
509 */
510 DomainName: DomainName;
511 }
512 export interface DescribeElasticsearchDomainConfigResponse {
513 /**
514 * The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.
515 */
516 DomainConfig: ElasticsearchDomainConfig;
517 }
518 export interface DescribeElasticsearchDomainRequest {
519 /**
520 * The name of the Elasticsearch domain for which you want information.
521 */
522 DomainName: DomainName;
523 }
524 export interface DescribeElasticsearchDomainResponse {
525 /**
526 * The current status of the Elasticsearch domain.
527 */
528 DomainStatus: ElasticsearchDomainStatus;
529 }
530 export interface DescribeElasticsearchDomainsRequest {
531 /**
532 * The Elasticsearch domains for which you want information.
533 */
534 DomainNames: DomainNameList;
535 }
536 export interface DescribeElasticsearchDomainsResponse {
537 /**
538 * The status of the domains requested in the DescribeElasticsearchDomains request.
539 */
540 DomainStatusList: ElasticsearchDomainStatusList;
541 }
542 export interface DescribeElasticsearchInstanceTypeLimitsRequest {
543 /**
544 * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.
545 */
546 DomainName?: DomainName;
547 /**
548 * The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.
549 */
550 InstanceType: ESPartitionInstanceType;
551 /**
552 * Version of Elasticsearch for which Limits are needed.
553 */
554 ElasticsearchVersion: ElasticsearchVersionString;
555 }
556 export interface DescribeElasticsearchInstanceTypeLimitsResponse {
557 LimitsByRole?: LimitsByRole;
558 }
559 export interface DescribePackagesFilter {
560 /**
561 * Any field from PackageDetails.
562 */
563 Name?: DescribePackagesFilterName;
564 /**
565 * A list of values for the specified field.
566 */
567 Value?: DescribePackagesFilterValues;
568 }
569 export type DescribePackagesFilterList = DescribePackagesFilter[];
570 export type DescribePackagesFilterName = "PackageID"|"PackageName"|"PackageStatus"|string;
571 export type DescribePackagesFilterValue = string;
572 export type DescribePackagesFilterValues = DescribePackagesFilterValue[];
573 export interface DescribePackagesRequest {
574 /**
575 * Only returns packages that match the DescribePackagesFilterList values.
576 */
577 Filters?: DescribePackagesFilterList;
578 /**
579 * Limits results to a maximum number of packages.
580 */
581 MaxResults?: MaxResults;
582 /**
583 * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
584 */
585 NextToken?: NextToken;
586 }
587 export interface DescribePackagesResponse {
588 /**
589 * List of PackageDetails objects.
590 */
591 PackageDetailsList?: PackageDetailsList;
592 NextToken?: String;
593 }
594 export interface DescribeReservedElasticsearchInstanceOfferingsRequest {
595 /**
596 * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
597 */
598 ReservedElasticsearchInstanceOfferingId?: GUID;
599 /**
600 * Set this value to limit the number of results returned. If not specified, defaults to 100.
601 */
602 MaxResults?: MaxResults;
603 /**
604 * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
605 */
606 NextToken?: NextToken;
607 }
608 export interface DescribeReservedElasticsearchInstanceOfferingsResponse {
609 /**
610 * Provides an identifier to allow retrieval of paginated results.
611 */
612 NextToken?: NextToken;
613 /**
614 * List of reserved Elasticsearch instance offerings
615 */
616 ReservedElasticsearchInstanceOfferings?: ReservedElasticsearchInstanceOfferingList;
617 }
618 export interface DescribeReservedElasticsearchInstancesRequest {
619 /**
620 * The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.
621 */
622 ReservedElasticsearchInstanceId?: GUID;
623 /**
624 * Set this value to limit the number of results returned. If not specified, defaults to 100.
625 */
626 MaxResults?: MaxResults;
627 /**
628 * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
629 */
630 NextToken?: NextToken;
631 }
632 export interface DescribeReservedElasticsearchInstancesResponse {
633 /**
634 * Provides an identifier to allow retrieval of paginated results.
635 */
636 NextToken?: String;
637 /**
638 * List of reserved Elasticsearch instances.
639 */
640 ReservedElasticsearchInstances?: ReservedElasticsearchInstanceList;
641 }
642 export interface DissociatePackageRequest {
643 /**
644 * Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
645 */
646 PackageID: PackageID;
647 /**
648 * Name of the domain that you want to associate the package with.
649 */
650 DomainName: DomainName;
651 }
652 export interface DissociatePackageResponse {
653 /**
654 * DomainPackageDetails
655 */
656 DomainPackageDetails?: DomainPackageDetails;
657 }
658 export interface DomainEndpointOptions {
659 /**
660 * Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
661 */
662 EnforceHTTPS?: Boolean;
663 /**
664 * Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher. Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
665 */
666 TLSSecurityPolicy?: TLSSecurityPolicy;
667 }
668 export interface DomainEndpointOptionsStatus {
669 /**
670 * Options to configure endpoint for the Elasticsearch domain.
671 */
672 Options: DomainEndpointOptions;
673 /**
674 * The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.
675 */
676 Status: OptionStatus;
677 }
678 export type DomainId = string;
679 export interface DomainInfo {
680 /**
681 * Specifies the DomainName.
682 */
683 DomainName?: DomainName;
684 }
685 export type DomainInfoList = DomainInfo[];
686 export type DomainName = string;
687 export type DomainNameList = DomainName[];
688 export interface DomainPackageDetails {
689 /**
690 * Internal ID of the package.
691 */
692 PackageID?: PackageID;
693 /**
694 * User specified name of the package.
695 */
696 PackageName?: PackageName;
697 /**
698 * Currently supports only TXT-DICTIONARY.
699 */
700 PackageType?: PackageType;
701 /**
702 * Timestamp of the most-recent update to the association status.
703 */
704 LastUpdated?: LastUpdated;
705 /**
706 * Name of the domain you've associated a package with.
707 */
708 DomainName?: DomainName;
709 /**
710 * State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
711 */
712 DomainPackageStatus?: DomainPackageStatus;
713 /**
714 * The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
715 */
716 ReferencePath?: ReferencePath;
717 /**
718 * Additional information if the package is in an error state. Null otherwise.
719 */
720 ErrorDetails?: ErrorDetails;
721 }
722 export type DomainPackageDetailsList = DomainPackageDetails[];
723 export type DomainPackageStatus = "ASSOCIATING"|"ASSOCIATION_FAILED"|"ACTIVE"|"DISSOCIATING"|"DISSOCIATION_FAILED"|string;
724 export type Double = number;
725 export interface EBSOptions {
726 /**
727 * Specifies whether EBS-based storage is enabled.
728 */
729 EBSEnabled?: Boolean;
730 /**
731 * Specifies the volume type for EBS-based storage.
732 */
733 VolumeType?: VolumeType;
734 /**
735 * Integer to specify the size of an EBS volume.
736 */
737 VolumeSize?: IntegerClass;
738 /**
739 * Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
740 */
741 Iops?: IntegerClass;
742 }
743 export interface EBSOptionsStatus {
744 /**
745 * Specifies the EBS options for the specified Elasticsearch domain.
746 */
747 Options: EBSOptions;
748 /**
749 * Specifies the status of the EBS options for the specified Elasticsearch domain.
750 */
751 Status: OptionStatus;
752 }
753 export type ESPartitionInstanceType = "m3.medium.elasticsearch"|"m3.large.elasticsearch"|"m3.xlarge.elasticsearch"|"m3.2xlarge.elasticsearch"|"m4.large.elasticsearch"|"m4.xlarge.elasticsearch"|"m4.2xlarge.elasticsearch"|"m4.4xlarge.elasticsearch"|"m4.10xlarge.elasticsearch"|"m5.large.elasticsearch"|"m5.xlarge.elasticsearch"|"m5.2xlarge.elasticsearch"|"m5.4xlarge.elasticsearch"|"m5.12xlarge.elasticsearch"|"r5.large.elasticsearch"|"r5.xlarge.elasticsearch"|"r5.2xlarge.elasticsearch"|"r5.4xlarge.elasticsearch"|"r5.12xlarge.elasticsearch"|"c5.large.elasticsearch"|"c5.xlarge.elasticsearch"|"c5.2xlarge.elasticsearch"|"c5.4xlarge.elasticsearch"|"c5.9xlarge.elasticsearch"|"c5.18xlarge.elasticsearch"|"ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|"t2.micro.elasticsearch"|"t2.small.elasticsearch"|"t2.medium.elasticsearch"|"r3.large.elasticsearch"|"r3.xlarge.elasticsearch"|"r3.2xlarge.elasticsearch"|"r3.4xlarge.elasticsearch"|"r3.8xlarge.elasticsearch"|"i2.xlarge.elasticsearch"|"i2.2xlarge.elasticsearch"|"d2.xlarge.elasticsearch"|"d2.2xlarge.elasticsearch"|"d2.4xlarge.elasticsearch"|"d2.8xlarge.elasticsearch"|"c4.large.elasticsearch"|"c4.xlarge.elasticsearch"|"c4.2xlarge.elasticsearch"|"c4.4xlarge.elasticsearch"|"c4.8xlarge.elasticsearch"|"r4.large.elasticsearch"|"r4.xlarge.elasticsearch"|"r4.2xlarge.elasticsearch"|"r4.4xlarge.elasticsearch"|"r4.8xlarge.elasticsearch"|"r4.16xlarge.elasticsearch"|"i3.large.elasticsearch"|"i3.xlarge.elasticsearch"|"i3.2xlarge.elasticsearch"|"i3.4xlarge.elasticsearch"|"i3.8xlarge.elasticsearch"|"i3.16xlarge.elasticsearch"|string;
754 export type ESWarmPartitionInstanceType = "ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|string;
755 export interface ElasticsearchClusterConfig {
756 /**
757 * The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
758 */
759 InstanceType?: ESPartitionInstanceType;
760 /**
761 * The number of instances in the specified domain cluster.
762 */
763 InstanceCount?: IntegerClass;
764 /**
765 * A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
766 */
767 DedicatedMasterEnabled?: Boolean;
768 /**
769 * A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
770 */
771 ZoneAwarenessEnabled?: Boolean;
772 /**
773 * Specifies the zone awareness configuration for a domain when zone awareness is enabled.
774 */
775 ZoneAwarenessConfig?: ZoneAwarenessConfig;
776 /**
777 * The instance type for a dedicated master node.
778 */
779 DedicatedMasterType?: ESPartitionInstanceType;
780 /**
781 * Total number of dedicated master nodes, active and on standby, for the cluster.
782 */
783 DedicatedMasterCount?: IntegerClass;
784 /**
785 * True to enable warm storage.
786 */
787 WarmEnabled?: Boolean;
788 /**
789 * The instance type for the Elasticsearch cluster's warm nodes.
790 */
791 WarmType?: ESWarmPartitionInstanceType;
792 /**
793 * The number of warm nodes in the cluster.
794 */
795 WarmCount?: IntegerClass;
796 }
797 export interface ElasticsearchClusterConfigStatus {
798 /**
799 * Specifies the cluster configuration for the specified Elasticsearch domain.
800 */
801 Options: ElasticsearchClusterConfig;
802 /**
803 * Specifies the status of the configuration for the specified Elasticsearch domain.
804 */
805 Status: OptionStatus;
806 }
807 export interface ElasticsearchDomainConfig {
808 /**
809 * String of format X.Y to specify version for the Elasticsearch domain.
810 */
811 ElasticsearchVersion?: ElasticsearchVersionStatus;
812 /**
813 * Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
814 */
815 ElasticsearchClusterConfig?: ElasticsearchClusterConfigStatus;
816 /**
817 * Specifies the EBSOptions for the Elasticsearch domain.
818 */
819 EBSOptions?: EBSOptionsStatus;
820 /**
821 * IAM access policy as a JSON-formatted string.
822 */
823 AccessPolicies?: AccessPoliciesStatus;
824 /**
825 * Specifies the SnapshotOptions for the Elasticsearch domain.
826 */
827 SnapshotOptions?: SnapshotOptionsStatus;
828 /**
829 * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
830 */
831 VPCOptions?: VPCDerivedInfoStatus;
832 /**
833 * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
834 */
835 CognitoOptions?: CognitoOptionsStatus;
836 /**
837 * Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
838 */
839 EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus;
840 /**
841 * Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
842 */
843 NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus;
844 /**
845 * Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
846 */
847 AdvancedOptions?: AdvancedOptionsStatus;
848 /**
849 * Log publishing options for the given domain.
850 */
851 LogPublishingOptions?: LogPublishingOptionsStatus;
852 /**
853 * Specifies the DomainEndpointOptions for the Elasticsearch domain.
854 */
855 DomainEndpointOptions?: DomainEndpointOptionsStatus;
856 /**
857 * Specifies AdvancedSecurityOptions for the domain.
858 */
859 AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
860 }
861 export interface ElasticsearchDomainStatus {
862 /**
863 * The unique identifier for the specified Elasticsearch domain.
864 */
865 DomainId: DomainId;
866 /**
867 * The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
868 */
869 DomainName: DomainName;
870 /**
871 * The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
872 */
873 ARN: ARN;
874 /**
875 * The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
876 */
877 Created?: Boolean;
878 /**
879 * The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
880 */
881 Deleted?: Boolean;
882 /**
883 * The Elasticsearch domain endpoint that you use to submit index and search requests.
884 */
885 Endpoint?: ServiceUrl;
886 /**
887 * Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
888 */
889 Endpoints?: EndpointsMap;
890 /**
891 * The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
892 */
893 Processing?: Boolean;
894 /**
895 * The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
896 */
897 UpgradeProcessing?: Boolean;
898 ElasticsearchVersion?: ElasticsearchVersionString;
899 /**
900 * The type and number of instances in the domain cluster.
901 */
902 ElasticsearchClusterConfig: ElasticsearchClusterConfig;
903 /**
904 * The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
905 */
906 EBSOptions?: EBSOptions;
907 /**
908 * IAM access policy as a JSON-formatted string.
909 */
910 AccessPolicies?: PolicyDocument;
911 /**
912 * Specifies the status of the SnapshotOptions
913 */
914 SnapshotOptions?: SnapshotOptions;
915 /**
916 * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
917 */
918 VPCOptions?: VPCDerivedInfo;
919 /**
920 * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
921 */
922 CognitoOptions?: CognitoOptions;
923 /**
924 * Specifies the status of the EncryptionAtRestOptions.
925 */
926 EncryptionAtRestOptions?: EncryptionAtRestOptions;
927 /**
928 * Specifies the status of the NodeToNodeEncryptionOptions.
929 */
930 NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
931 /**
932 * Specifies the status of the AdvancedOptions
933 */
934 AdvancedOptions?: AdvancedOptions;
935 /**
936 * Log publishing options for the given domain.
937 */
938 LogPublishingOptions?: LogPublishingOptions;
939 /**
940 * The current status of the Elasticsearch domain's service software.
941 */
942 ServiceSoftwareOptions?: ServiceSoftwareOptions;
943 /**
944 * The current status of the Elasticsearch domain's endpoint options.
945 */
946 DomainEndpointOptions?: DomainEndpointOptions;
947 /**
948 * The current status of the Elasticsearch domain's advanced security options.
949 */
950 AdvancedSecurityOptions?: AdvancedSecurityOptions;
951 }
952 export type ElasticsearchDomainStatusList = ElasticsearchDomainStatus[];
953 export type ElasticsearchInstanceTypeList = ESPartitionInstanceType[];
954 export type ElasticsearchVersionList = ElasticsearchVersionString[];
955 export interface ElasticsearchVersionStatus {
956 /**
957 * Specifies the Elasticsearch version for the specified Elasticsearch domain.
958 */
959 Options: ElasticsearchVersionString;
960 /**
961 * Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
962 */
963 Status: OptionStatus;
964 }
965 export type ElasticsearchVersionString = string;
966 export interface EncryptionAtRestOptions {
967 /**
968 * Specifies the option to enable Encryption At Rest.
969 */
970 Enabled?: Boolean;
971 /**
972 * Specifies the KMS Key ID for Encryption At Rest options.
973 */
974 KmsKeyId?: KmsKeyId;
975 }
976 export interface EncryptionAtRestOptionsStatus {
977 /**
978 * Specifies the Encryption At Rest options for the specified Elasticsearch domain.
979 */
980 Options: EncryptionAtRestOptions;
981 /**
982 * Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
983 */
984 Status: OptionStatus;
985 }
986 export type EndpointsMap = {[key: string]: ServiceUrl};
987 export interface ErrorDetails {
988 ErrorType?: ErrorType;
989 ErrorMessage?: ErrorMessage;
990 }
991 export type ErrorMessage = string;
992 export type ErrorType = string;
993 export type GUID = string;
994 export interface GetCompatibleElasticsearchVersionsRequest {
995 DomainName?: DomainName;
996 }
997 export interface GetCompatibleElasticsearchVersionsResponse {
998 /**
999 * A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.
1000 */
1001 CompatibleElasticsearchVersions?: CompatibleElasticsearchVersionsList;
1002 }
1003 export interface GetUpgradeHistoryRequest {
1004 DomainName: DomainName;
1005 MaxResults?: MaxResults;
1006 NextToken?: NextToken;
1007 }
1008 export interface GetUpgradeHistoryResponse {
1009 /**
1010 * A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.
1011 */
1012 UpgradeHistories?: UpgradeHistoryList;
1013 /**
1014 * Pagination token that needs to be supplied to the next call to get the next page of results
1015 */
1016 NextToken?: String;
1017 }
1018 export interface GetUpgradeStatusRequest {
1019 DomainName: DomainName;
1020 }
1021 export interface GetUpgradeStatusResponse {
1022 /**
1023 * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
1024 */
1025 UpgradeStep?: UpgradeStep;
1026 /**
1027 * One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
1028 */
1029 StepStatus?: UpgradeStatus;
1030 /**
1031 * A string that describes the update briefly
1032 */
1033 UpgradeName?: UpgradeName;
1034 }
1035 export type IdentityPoolId = string;
1036 export type InstanceCount = number;
1037 export interface InstanceCountLimits {
1038 MinimumInstanceCount?: MinimumInstanceCount;
1039 MaximumInstanceCount?: MaximumInstanceCount;
1040 }
1041 export interface InstanceLimits {
1042 InstanceCountLimits?: InstanceCountLimits;
1043 }
1044 export type InstanceRole = string;
1045 export type Integer = number;
1046 export type IntegerClass = number;
1047 export type Issue = string;
1048 export type Issues = Issue[];
1049 export type KmsKeyId = string;
1050 export type LastUpdated = Date;
1051 export type LimitName = string;
1052 export type LimitValue = string;
1053 export type LimitValueList = LimitValue[];
1054 export interface Limits {
1055 /**
1056 * StorageType represents the list of storage related types and attributes that are available for given InstanceType.
1057 */
1058 StorageTypes?: StorageTypeList;
1059 InstanceLimits?: InstanceLimits;
1060 /**
1061 * List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole .
1062 */
1063 AdditionalLimits?: AdditionalLimitList;
1064 }
1065 export type LimitsByRole = {[key: string]: Limits};
1066 export interface ListDomainNamesResponse {
1067 /**
1068 * List of Elasticsearch domain names.
1069 */
1070 DomainNames?: DomainInfoList;
1071 }
1072 export interface ListDomainsForPackageRequest {
1073 /**
1074 * The package for which to list domains.
1075 */
1076 PackageID: PackageID;
1077 /**
1078 * Limits results to a maximum number of domains.
1079 */
1080 MaxResults?: MaxResults;
1081 /**
1082 * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1083 */
1084 NextToken?: NextToken;
1085 }
1086 export interface ListDomainsForPackageResponse {
1087 /**
1088 * List of DomainPackageDetails objects.
1089 */
1090 DomainPackageDetailsList?: DomainPackageDetailsList;
1091 NextToken?: String;
1092 }
1093 export interface ListElasticsearchInstanceTypesRequest {
1094 /**
1095 * Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
1096 */
1097 ElasticsearchVersion: ElasticsearchVersionString;
1098 /**
1099 * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.
1100 */
1101 DomainName?: DomainName;
1102 /**
1103 * Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.
1104 */
1105 MaxResults?: MaxResults;
1106 /**
1107 * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
1108 */
1109 NextToken?: NextToken;
1110 }
1111 export interface ListElasticsearchInstanceTypesResponse {
1112 /**
1113 * List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion
1114 */
1115 ElasticsearchInstanceTypes?: ElasticsearchInstanceTypeList;
1116 /**
1117 * In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.
1118 */
1119 NextToken?: NextToken;
1120 }
1121 export interface ListElasticsearchVersionsRequest {
1122 /**
1123 * Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.
1124 */
1125 MaxResults?: MaxResults;
1126 NextToken?: NextToken;
1127 }
1128 export interface ListElasticsearchVersionsResponse {
1129 ElasticsearchVersions?: ElasticsearchVersionList;
1130 NextToken?: NextToken;
1131 }
1132 export interface ListPackagesForDomainRequest {
1133 /**
1134 * The name of the domain for which you want to list associated packages.
1135 */
1136 DomainName: DomainName;
1137 /**
1138 * Limits results to a maximum number of packages.
1139 */
1140 MaxResults?: MaxResults;
1141 /**
1142 * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1143 */
1144 NextToken?: NextToken;
1145 }
1146 export interface ListPackagesForDomainResponse {
1147 /**
1148 * List of DomainPackageDetails objects.
1149 */
1150 DomainPackageDetailsList?: DomainPackageDetailsList;
1151 /**
1152 * Pagination token that needs to be supplied to the next call to get the next page of results.
1153 */
1154 NextToken?: String;
1155 }
1156 export interface ListTagsRequest {
1157 /**
1158 * Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
1159 */
1160 ARN: ARN;
1161 }
1162 export interface ListTagsResponse {
1163 /**
1164 * List of Tag for the requested Elasticsearch domain.
1165 */
1166 TagList?: TagList;
1167 }
1168 export interface LogPublishingOption {
1169 CloudWatchLogsLogGroupArn?: CloudWatchLogsLogGroupArn;
1170 /**
1171 * Specifies whether given log publishing option is enabled or not.
1172 */
1173 Enabled?: Boolean;
1174 }
1175 export type LogPublishingOptions = {[key: string]: LogPublishingOption};
1176 export interface LogPublishingOptionsStatus {
1177 /**
1178 * The log publishing options configured for the Elasticsearch domain.
1179 */
1180 Options?: LogPublishingOptions;
1181 /**
1182 * The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.
1183 */
1184 Status?: OptionStatus;
1185 }
1186 export type LogType = "INDEX_SLOW_LOGS"|"SEARCH_SLOW_LOGS"|"ES_APPLICATION_LOGS"|string;
1187 export interface MasterUserOptions {
1188 /**
1189 * ARN for the master user (if IAM is enabled).
1190 */
1191 MasterUserARN?: ARN;
1192 /**
1193 * The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.
1194 */
1195 MasterUserName?: Username;
1196 /**
1197 * The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.
1198 */
1199 MasterUserPassword?: Password;
1200 }
1201 export type MaxResults = number;
1202 export type MaximumInstanceCount = number;
1203 export type MinimumInstanceCount = number;
1204 export type NextToken = string;
1205 export interface NodeToNodeEncryptionOptions {
1206 /**
1207 * Specify true to enable node-to-node encryption.
1208 */
1209 Enabled?: Boolean;
1210 }
1211 export interface NodeToNodeEncryptionOptionsStatus {
1212 /**
1213 * Specifies the node-to-node encryption options for the specified Elasticsearch domain.
1214 */
1215 Options: NodeToNodeEncryptionOptions;
1216 /**
1217 * Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
1218 */
1219 Status: OptionStatus;
1220 }
1221 export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|string;
1222 export interface OptionStatus {
1223 /**
1224 * Timestamp which tells the creation date for the entity.
1225 */
1226 CreationDate: UpdateTimestamp;
1227 /**
1228 * Timestamp which tells the last updated time for the entity.
1229 */
1230 UpdateDate: UpdateTimestamp;
1231 /**
1232 * Specifies the latest version for the entity.
1233 */
1234 UpdateVersion?: UIntValue;
1235 /**
1236 * Provides the OptionState for the Elasticsearch domain.
1237 */
1238 State: OptionState;
1239 /**
1240 * Indicates whether the Elasticsearch domain is being deleted.
1241 */
1242 PendingDeletion?: Boolean;
1243 }
1244 export type PackageDescription = string;
1245 export interface PackageDetails {
1246 /**
1247 * Internal ID of the package.
1248 */
1249 PackageID?: PackageID;
1250 /**
1251 * User specified name of the package.
1252 */
1253 PackageName?: PackageName;
1254 /**
1255 * Currently supports only TXT-DICTIONARY.
1256 */
1257 PackageType?: PackageType;
1258 /**
1259 * User-specified description of the package.
1260 */
1261 PackageDescription?: PackageDescription;
1262 /**
1263 * Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
1264 */
1265 PackageStatus?: PackageStatus;
1266 /**
1267 * Timestamp which tells creation date of the package.
1268 */
1269 CreatedAt?: CreatedAt;
1270 /**
1271 * Additional information if the package is in an error state. Null otherwise.
1272 */
1273 ErrorDetails?: ErrorDetails;
1274 }
1275 export type PackageDetailsList = PackageDetails[];
1276 export type PackageID = string;
1277 export type PackageName = string;
1278 export interface PackageSource {
1279 /**
1280 * Name of the bucket containing the package.
1281 */
1282 S3BucketName?: S3BucketName;
1283 /**
1284 * Key (file name) of the package.
1285 */
1286 S3Key?: S3Key;
1287 }
1288 export type PackageStatus = "COPYING"|"COPY_FAILED"|"VALIDATING"|"VALIDATION_FAILED"|"AVAILABLE"|"DELETING"|"DELETED"|"DELETE_FAILED"|string;
1289 export type PackageType = "TXT-DICTIONARY"|string;
1290 export type Password = string;
1291 export type PolicyDocument = string;
1292 export interface PurchaseReservedElasticsearchInstanceOfferingRequest {
1293 /**
1294 * The ID of the reserved Elasticsearch instance offering to purchase.
1295 */
1296 ReservedElasticsearchInstanceOfferingId: GUID;
1297 /**
1298 * A customer-specified identifier to track this reservation.
1299 */
1300 ReservationName: ReservationToken;
1301 /**
1302 * The number of Elasticsearch instances to reserve.
1303 */
1304 InstanceCount?: InstanceCount;
1305 }
1306 export interface PurchaseReservedElasticsearchInstanceOfferingResponse {
1307 /**
1308 * Details of the reserved Elasticsearch instance which was purchased.
1309 */
1310 ReservedElasticsearchInstanceId?: GUID;
1311 /**
1312 * The customer-specified identifier used to track this reservation.
1313 */
1314 ReservationName?: ReservationToken;
1315 }
1316 export interface RecurringCharge {
1317 /**
1318 * The monetary amount of the recurring charge.
1319 */
1320 RecurringChargeAmount?: Double;
1321 /**
1322 * The frequency of the recurring charge.
1323 */
1324 RecurringChargeFrequency?: String;
1325 }
1326 export type RecurringChargeList = RecurringCharge[];
1327 export type ReferencePath = string;
1328 export interface RemoveTagsRequest {
1329 /**
1330 * Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.
1331 */
1332 ARN: ARN;
1333 /**
1334 * Specifies the TagKey list which you want to remove from the Elasticsearch domain.
1335 */
1336 TagKeys: StringList;
1337 }
1338 export type ReservationToken = string;
1339 export interface ReservedElasticsearchInstance {
1340 /**
1341 * The customer-specified identifier to track this reservation.
1342 */
1343 ReservationName?: ReservationToken;
1344 /**
1345 * The unique identifier for the reservation.
1346 */
1347 ReservedElasticsearchInstanceId?: GUID;
1348 /**
1349 * The offering identifier.
1350 */
1351 ReservedElasticsearchInstanceOfferingId?: String;
1352 /**
1353 * The Elasticsearch instance type offered by the reserved instance offering.
1354 */
1355 ElasticsearchInstanceType?: ESPartitionInstanceType;
1356 /**
1357 * The time the reservation started.
1358 */
1359 StartTime?: UpdateTimestamp;
1360 /**
1361 * The duration, in seconds, for which the Elasticsearch instance is reserved.
1362 */
1363 Duration?: Integer;
1364 /**
1365 * The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
1366 */
1367 FixedPrice?: Double;
1368 /**
1369 * The rate you are charged for each hour for the domain that is using this reserved instance.
1370 */
1371 UsagePrice?: Double;
1372 /**
1373 * The currency code for the reserved Elasticsearch instance offering.
1374 */
1375 CurrencyCode?: String;
1376 /**
1377 * The number of Elasticsearch instances that have been reserved.
1378 */
1379 ElasticsearchInstanceCount?: Integer;
1380 /**
1381 * The state of the reserved Elasticsearch instance.
1382 */
1383 State?: String;
1384 /**
1385 * The payment option as defined in the reserved Elasticsearch instance offering.
1386 */
1387 PaymentOption?: ReservedElasticsearchInstancePaymentOption;
1388 /**
1389 * The charge to your account regardless of whether you are creating any domains using the instance offering.
1390 */
1391 RecurringCharges?: RecurringChargeList;
1392 }
1393 export type ReservedElasticsearchInstanceList = ReservedElasticsearchInstance[];
1394 export interface ReservedElasticsearchInstanceOffering {
1395 /**
1396 * The Elasticsearch reserved instance offering identifier.
1397 */
1398 ReservedElasticsearchInstanceOfferingId?: GUID;
1399 /**
1400 * The Elasticsearch instance type offered by the reserved instance offering.
1401 */
1402 ElasticsearchInstanceType?: ESPartitionInstanceType;
1403 /**
1404 * The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
1405 */
1406 Duration?: Integer;
1407 /**
1408 * The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
1409 */
1410 FixedPrice?: Double;
1411 /**
1412 * The rate you are charged for each hour the domain that is using the offering is running.
1413 */
1414 UsagePrice?: Double;
1415 /**
1416 * The currency code for the reserved Elasticsearch instance offering.
1417 */
1418 CurrencyCode?: String;
1419 /**
1420 * Payment option for the reserved Elasticsearch instance offering
1421 */
1422 PaymentOption?: ReservedElasticsearchInstancePaymentOption;
1423 /**
1424 * The charge to your account regardless of whether you are creating any domains using the instance offering.
1425 */
1426 RecurringCharges?: RecurringChargeList;
1427 }
1428 export type ReservedElasticsearchInstanceOfferingList = ReservedElasticsearchInstanceOffering[];
1429 export type ReservedElasticsearchInstancePaymentOption = "ALL_UPFRONT"|"PARTIAL_UPFRONT"|"NO_UPFRONT"|string;
1430 export type RoleArn = string;
1431 export type S3BucketName = string;
1432 export type S3Key = string;
1433 export interface ServiceSoftwareOptions {
1434 /**
1435 * The current service software version that is present on the domain.
1436 */
1437 CurrentVersion?: String;
1438 /**
1439 * The new service software version if one is available.
1440 */
1441 NewVersion?: String;
1442 /**
1443 * True if you are able to update you service software version. False if you are not able to update your service software version.
1444 */
1445 UpdateAvailable?: Boolean;
1446 /**
1447 * True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
1448 */
1449 Cancellable?: Boolean;
1450 /**
1451 * The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
1452 */
1453 UpdateStatus?: DeploymentStatus;
1454 /**
1455 * The description of the UpdateStatus.
1456 */
1457 Description?: String;
1458 /**
1459 * Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
1460 */
1461 AutomatedUpdateDate?: DeploymentCloseDateTimeStamp;
1462 }
1463 export type ServiceUrl = string;
1464 export interface SnapshotOptions {
1465 /**
1466 * Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
1467 */
1468 AutomatedSnapshotStartHour?: IntegerClass;
1469 }
1470 export interface SnapshotOptionsStatus {
1471 /**
1472 * Specifies the daily snapshot options specified for the Elasticsearch domain.
1473 */
1474 Options: SnapshotOptions;
1475 /**
1476 * Specifies the status of a daily automated snapshot.
1477 */
1478 Status: OptionStatus;
1479 }
1480 export interface StartElasticsearchServiceSoftwareUpdateRequest {
1481 /**
1482 * The name of the domain that you want to update to the latest service software.
1483 */
1484 DomainName: DomainName;
1485 }
1486 export interface StartElasticsearchServiceSoftwareUpdateResponse {
1487 /**
1488 * The current status of the Elasticsearch service software update.
1489 */
1490 ServiceSoftwareOptions?: ServiceSoftwareOptions;
1491 }
1492 export type StartTimestamp = Date;
1493 export type StorageSubTypeName = string;
1494 export interface StorageType {
1495 StorageTypeName?: StorageTypeName;
1496 StorageSubTypeName?: StorageSubTypeName;
1497 /**
1498 * List of limits that are applicable for given storage type.
1499 */
1500 StorageTypeLimits?: StorageTypeLimitList;
1501 }
1502 export interface StorageTypeLimit {
1503 /**
1504 * Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable MinimumVolumeSize Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumVolumeSize Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumIops Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. MinimumIops Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
1505 */
1506 LimitName?: LimitName;
1507 /**
1508 * Values for the StorageTypeLimit$LimitName .
1509 */
1510 LimitValues?: LimitValueList;
1511 }
1512 export type StorageTypeLimitList = StorageTypeLimit[];
1513 export type StorageTypeList = StorageType[];
1514 export type StorageTypeName = string;
1515 export type String = string;
1516 export type StringList = String[];
1517 export type TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|string;
1518 export interface Tag {
1519 /**
1520 * Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
1521 */
1522 Key: TagKey;
1523 /**
1524 * Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
1525 */
1526 Value: TagValue;
1527 }
1528 export type TagKey = string;
1529 export type TagList = Tag[];
1530 export type TagValue = string;
1531 export type UIntValue = number;
1532 export interface UpdateElasticsearchDomainConfigRequest {
1533 /**
1534 * The name of the Elasticsearch domain that you are updating.
1535 */
1536 DomainName: DomainName;
1537 /**
1538 * The type and number of instances to instantiate for the domain cluster.
1539 */
1540 ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
1541 /**
1542 * Specify the type and size of the EBS volume that you want to use.
1543 */
1544 EBSOptions?: EBSOptions;
1545 /**
1546 * Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
1547 */
1548 SnapshotOptions?: SnapshotOptions;
1549 /**
1550 * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
1551 */
1552 VPCOptions?: VPCOptions;
1553 /**
1554 * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
1555 */
1556 CognitoOptions?: CognitoOptions;
1557 /**
1558 * Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
1559 */
1560 AdvancedOptions?: AdvancedOptions;
1561 /**
1562 * IAM access policy as a JSON-formatted string.
1563 */
1564 AccessPolicies?: PolicyDocument;
1565 /**
1566 * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
1567 */
1568 LogPublishingOptions?: LogPublishingOptions;
1569 /**
1570 * Options to specify configuration that will be applied to the domain endpoint.
1571 */
1572 DomainEndpointOptions?: DomainEndpointOptions;
1573 /**
1574 * Specifies advanced security options.
1575 */
1576 AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
1577 }
1578 export interface UpdateElasticsearchDomainConfigResponse {
1579 /**
1580 * The status of the updated Elasticsearch domain.
1581 */
1582 DomainConfig: ElasticsearchDomainConfig;
1583 }
1584 export type UpdateTimestamp = Date;
1585 export interface UpgradeElasticsearchDomainRequest {
1586 DomainName: DomainName;
1587 /**
1588 * The version of Elasticsearch that you intend to upgrade the domain to.
1589 */
1590 TargetVersion: ElasticsearchVersionString;
1591 /**
1592 * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
1593 */
1594 PerformCheckOnly?: Boolean;
1595 }
1596 export interface UpgradeElasticsearchDomainResponse {
1597 DomainName?: DomainName;
1598 /**
1599 * The version of Elasticsearch that you intend to upgrade the domain to.
1600 */
1601 TargetVersion?: ElasticsearchVersionString;
1602 /**
1603 * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
1604 */
1605 PerformCheckOnly?: Boolean;
1606 }
1607 export interface UpgradeHistory {
1608 /**
1609 * A string that describes the update briefly
1610 */
1611 UpgradeName?: UpgradeName;
1612 /**
1613 * UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
1614 */
1615 StartTimestamp?: StartTimestamp;
1616 /**
1617 * The overall status of the update. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
1618 */
1619 UpgradeStatus?: UpgradeStatus;
1620 /**
1621 * A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.
1622 */
1623 StepsList?: UpgradeStepsList;
1624 }
1625 export type UpgradeHistoryList = UpgradeHistory[];
1626 export type UpgradeName = string;
1627 export type UpgradeStatus = "IN_PROGRESS"|"SUCCEEDED"|"SUCCEEDED_WITH_ISSUES"|"FAILED"|string;
1628 export type UpgradeStep = "PRE_UPGRADE_CHECK"|"SNAPSHOT"|"UPGRADE"|string;
1629 export interface UpgradeStepItem {
1630 /**
1631 * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
1632 */
1633 UpgradeStep?: UpgradeStep;
1634 /**
1635 * The status of a particular step during an upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
1636 */
1637 UpgradeStepStatus?: UpgradeStatus;
1638 /**
1639 * A list of strings containing detailed information about the errors encountered in a particular step.
1640 */
1641 Issues?: Issues;
1642 /**
1643 * The Floating point value representing progress percentage of a particular step.
1644 */
1645 ProgressPercent?: Double;
1646 }
1647 export type UpgradeStepsList = UpgradeStepItem[];
1648 export type UserPoolId = string;
1649 export type Username = string;
1650 export interface VPCDerivedInfo {
1651 /**
1652 * The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
1653 */
1654 VPCId?: String;
1655 /**
1656 * Specifies the subnets for VPC endpoint.
1657 */
1658 SubnetIds?: StringList;
1659 /**
1660 * The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
1661 */
1662 AvailabilityZones?: StringList;
1663 /**
1664 * Specifies the security groups for VPC endpoint.
1665 */
1666 SecurityGroupIds?: StringList;
1667 }
1668 export interface VPCDerivedInfoStatus {
1669 /**
1670 * Specifies the VPC options for the specified Elasticsearch domain.
1671 */
1672 Options: VPCDerivedInfo;
1673 /**
1674 * Specifies the status of the VPC options for the specified Elasticsearch domain.
1675 */
1676 Status: OptionStatus;
1677 }
1678 export interface VPCOptions {
1679 /**
1680 * Specifies the subnets for VPC endpoint.
1681 */
1682 SubnetIds?: StringList;
1683 /**
1684 * Specifies the security groups for VPC endpoint.
1685 */
1686 SecurityGroupIds?: StringList;
1687 }
1688 export type VolumeType = "standard"|"gp2"|"io1"|string;
1689 export interface ZoneAwarenessConfig {
1690 /**
1691 * An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
1692 */
1693 AvailabilityZoneCount?: IntegerClass;
1694 }
1695 /**
1696 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1697 */
1698 export type apiVersion = "2015-01-01"|"latest"|string;
1699 export interface ClientApiVersions {
1700 /**
1701 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1702 */
1703 apiVersion?: apiVersion;
1704 }
1705 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1706 /**
1707 * Contains interfaces for use with the ES client.
1708 */
1709 export import Types = ES;
1710}
1711export = ES;