💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2023-01-29 at 11:52:10. Gemini links have been rewritten to link to archived content
-=-=-=-=-=-=-
es.d.ts (22181B)
1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare 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 * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
24 */
25 createElasticsearchDomain(params: ES.Types.CreateElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
26 /**
27 * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
28 */
29 createElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
30 /**
31 * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
32 */
33 deleteElasticsearchDomain(params: ES.Types.DeleteElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
34 /**
35 * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
36 */
37 deleteElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
38 /**
39 * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
40 */
41 describeElasticsearchDomain(params: ES.Types.DescribeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
42 /**
43 * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
44 */
45 describeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
46 /**
47 * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
48 */
49 describeElasticsearchDomainConfig(params: ES.Types.DescribeElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
50 /**
51 * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
52 */
53 describeElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
54 /**
55 * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
56 */
57 describeElasticsearchDomains(params: ES.Types.DescribeElasticsearchDomainsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
58 /**
59 * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
60 */
61 describeElasticsearchDomains(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
62 /**
63 * Returns the name of all Elasticsearch domains owned by the current user's account.
64 */
65 listDomainNames(callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
66 /**
67 * Returns all tags for the given Elasticsearch domain.
68 */
69 listTags(params: ES.Types.ListTagsRequest, callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
70 /**
71 * Returns all tags for the given Elasticsearch domain.
72 */
73 listTags(callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
74 /**
75 * Removes the specified set of tags from the specified Elasticsearch domain.
76 */
77 removeTags(params: ES.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Removes the specified set of tags from the specified Elasticsearch domain.
80 */
81 removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
84 */
85 updateElasticsearchDomainConfig(params: ES.Types.UpdateElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
86 /**
87 * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
88 */
89 updateElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
90 }
91 declare namespace ES.Types {
92 export type ARN = string;
93 export interface AccessPoliciesStatus {
94 /**
95 * 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.
96 */
97 Options: PolicyDocument;
98 /**
99 * The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
100 */
101 Status: OptionStatus;
102 }
103 export interface AddTagsRequest {
104 /**
105 * Specify the ARN for which you want to add the tags.
106 */
107 ARN: ARN;
108 /**
109 * List of Tag that need to be added for the Elasticsearch domain.
110 */
111 TagList: TagList;
112 }
113 export type AdvancedOptions = {[key: string]: String};
114 export interface AdvancedOptionsStatus {
115 /**
116 * Specifies the status of advanced options for the specified Elasticsearch domain.
117 */
118 Options: AdvancedOptions;
119 /**
120 * Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
121 */
122 Status: OptionStatus;
123 }
124 export type Boolean = boolean;
125 export interface CreateElasticsearchDomainRequest {
126 /**
127 * 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 letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
128 */
129 DomainName: DomainName;
130 /**
131 * 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.
132 */
133 ElasticsearchVersion?: ElasticsearchVersionString;
134 /**
135 * Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
136 */
137 ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
138 /**
139 * Options to enable, disable and specify the type and size of EBS storage volumes.
140 */
141 EBSOptions?: EBSOptions;
142 /**
143 * IAM access policy as a JSON-formatted string.
144 */
145 AccessPolicies?: PolicyDocument;
146 /**
147 * Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
148 */
149 SnapshotOptions?: SnapshotOptions;
150 /**
151 * 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.
152 */
153 AdvancedOptions?: AdvancedOptions;
154 }
155 export interface CreateElasticsearchDomainResponse {
156 /**
157 * The status of the newly created Elasticsearch domain.
158 */
159 DomainStatus?: ElasticsearchDomainStatus;
160 }
161 export interface DeleteElasticsearchDomainRequest {
162 /**
163 * The name of the Elasticsearch domain that you want to permanently delete.
164 */
165 DomainName: DomainName;
166 }
167 export interface DeleteElasticsearchDomainResponse {
168 /**
169 * The status of the Elasticsearch domain being deleted.
170 */
171 DomainStatus?: ElasticsearchDomainStatus;
172 }
173 export interface DescribeElasticsearchDomainConfigRequest {
174 /**
175 * The Elasticsearch domain that you want to get information about.
176 */
177 DomainName: DomainName;
178 }
179 export interface DescribeElasticsearchDomainConfigResponse {
180 /**
181 * The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.
182 */
183 DomainConfig: ElasticsearchDomainConfig;
184 }
185 export interface DescribeElasticsearchDomainRequest {
186 /**
187 * The name of the Elasticsearch domain for which you want information.
188 */
189 DomainName: DomainName;
190 }
191 export interface DescribeElasticsearchDomainResponse {
192 /**
193 * The current status of the Elasticsearch domain.
194 */
195 DomainStatus: ElasticsearchDomainStatus;
196 }
197 export interface DescribeElasticsearchDomainsRequest {
198 /**
199 * The Elasticsearch domains for which you want information.
200 */
201 DomainNames: DomainNameList;
202 }
203 export interface DescribeElasticsearchDomainsResponse {
204 /**
205 * The status of the domains requested in the DescribeElasticsearchDomains request.
206 */
207 DomainStatusList: ElasticsearchDomainStatusList;
208 }
209 export type DomainId = string;
210 export interface DomainInfo {
211 /**
212 * Specifies the DomainName.
213 */
214 DomainName?: DomainName;
215 }
216 export type DomainInfoList = DomainInfo[];
217 export type DomainName = string;
218 export type DomainNameList = DomainName[];
219 export interface EBSOptions {
220 /**
221 * Specifies whether EBS-based storage is enabled.
222 */
223 EBSEnabled?: Boolean;
224 /**
225 * Specifies the volume type for EBS-based storage.
226 */
227 VolumeType?: VolumeType;
228 /**
229 * Integer to specify the size of an EBS volume.
230 */
231 VolumeSize?: IntegerClass;
232 /**
233 * Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
234 */
235 Iops?: IntegerClass;
236 }
237 export interface EBSOptionsStatus {
238 /**
239 * Specifies the EBS options for the specified Elasticsearch domain.
240 */
241 Options: EBSOptions;
242 /**
243 * Specifies the status of the EBS options for the specified Elasticsearch domain.
244 */
245 Status: OptionStatus;
246 }
247 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"|"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"|string;
248 export interface ElasticsearchClusterConfig {
249 /**
250 * The instance type for an Elasticsearch cluster.
251 */
252 InstanceType?: ESPartitionInstanceType;
253 /**
254 * The number of instances in the specified domain cluster.
255 */
256 InstanceCount?: IntegerClass;
257 /**
258 * A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
259 */
260 DedicatedMasterEnabled?: Boolean;
261 /**
262 * A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
263 */
264 ZoneAwarenessEnabled?: Boolean;
265 /**
266 * The instance type for a dedicated master node.
267 */
268 DedicatedMasterType?: ESPartitionInstanceType;
269 /**
270 * Total number of dedicated master nodes, active and on standby, for the cluster.
271 */
272 DedicatedMasterCount?: IntegerClass;
273 }
274 export interface ElasticsearchClusterConfigStatus {
275 /**
276 * Specifies the cluster configuration for the specified Elasticsearch domain.
277 */
278 Options: ElasticsearchClusterConfig;
279 /**
280 * Specifies the status of the configuration for the specified Elasticsearch domain.
281 */
282 Status: OptionStatus;
283 }
284 export interface ElasticsearchDomainConfig {
285 /**
286 * String of format X.Y to specify version for the Elasticsearch domain.
287 */
288 ElasticsearchVersion?: ElasticsearchVersionStatus;
289 /**
290 * Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
291 */
292 ElasticsearchClusterConfig?: ElasticsearchClusterConfigStatus;
293 /**
294 * Specifies the EBSOptions for the Elasticsearch domain.
295 */
296 EBSOptions?: EBSOptionsStatus;
297 /**
298 * IAM access policy as a JSON-formatted string.
299 */
300 AccessPolicies?: AccessPoliciesStatus;
301 /**
302 * Specifies the SnapshotOptions for the Elasticsearch domain.
303 */
304 SnapshotOptions?: SnapshotOptionsStatus;
305 /**
306 * Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
307 */
308 AdvancedOptions?: AdvancedOptionsStatus;
309 }
310 export interface ElasticsearchDomainStatus {
311 /**
312 * The unique identifier for the specified Elasticsearch domain.
313 */
314 DomainId: DomainId;
315 /**
316 * 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).
317 */
318 DomainName: DomainName;
319 /**
320 * The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
321 */
322 ARN: ARN;
323 /**
324 * The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
325 */
326 Created?: Boolean;
327 /**
328 * 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.
329 */
330 Deleted?: Boolean;
331 /**
332 * The Elasticsearch domain endpoint that you use to submit index and search requests.
333 */
334 Endpoint?: ServiceUrl;
335 /**
336 * The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
337 */
338 Processing?: Boolean;
339 ElasticsearchVersion?: ElasticsearchVersionString;
340 /**
341 * The type and number of instances in the domain cluster.
342 */
343 ElasticsearchClusterConfig: ElasticsearchClusterConfig;
344 /**
345 * The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
346 */
347 EBSOptions?: EBSOptions;
348 /**
349 * IAM access policy as a JSON-formatted string.
350 */
351 AccessPolicies?: PolicyDocument;
352 /**
353 * Specifies the status of the SnapshotOptions
354 */
355 SnapshotOptions?: SnapshotOptions;
356 /**
357 * Specifies the status of the AdvancedOptions
358 */
359 AdvancedOptions?: AdvancedOptions;
360 }
361 export type ElasticsearchDomainStatusList = ElasticsearchDomainStatus[];
362 export interface ElasticsearchVersionStatus {
363 /**
364 * Specifies the Elasticsearch version for the specified Elasticsearch domain.
365 */
366 Options: ElasticsearchVersionString;
367 /**
368 * Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
369 */
370 Status: OptionStatus;
371 }
372 export type ElasticsearchVersionString = string;
373 export type ErrorMessage = string;
374 export type IntegerClass = number;
375 export interface ListDomainNamesResponse {
376 /**
377 * List of Elasticsearch domain names.
378 */
379 DomainNames?: DomainInfoList;
380 }
381 export interface ListTagsRequest {
382 /**
383 * Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
384 */
385 ARN: ARN;
386 }
387 export interface ListTagsResponse {
388 /**
389 * List of Tag for the requested Elasticsearch domain.
390 */
391 TagList?: TagList;
392 }
393 export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|string;
394 export interface OptionStatus {
395 /**
396 * Timestamp which tells the creation date for the entity.
397 */
398 CreationDate: UpdateTimestamp;
399 /**
400 * Timestamp which tells the last updated time for the entity.
401 */
402 UpdateDate: UpdateTimestamp;
403 /**
404 * Specifies the latest version for the entity.
405 */
406 UpdateVersion?: UIntValue;
407 /**
408 * Provides the OptionState for the Elasticsearch domain.
409 */
410 State: OptionState;
411 /**
412 * Indicates whether the Elasticsearch domain is being deleted.
413 */
414 PendingDeletion?: Boolean;
415 }
416 export type PolicyDocument = string;
417 export interface RemoveTagsRequest {
418 /**
419 * Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.
420 */
421 ARN: ARN;
422 /**
423 * Specifies the TagKey list which you want to remove from the Elasticsearch domain.
424 */
425 TagKeys: StringList;
426 }
427 export type ServiceUrl = string;
428 export interface SnapshotOptions {
429 /**
430 * Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
431 */
432 AutomatedSnapshotStartHour?: IntegerClass;
433 }
434 export interface SnapshotOptionsStatus {
435 /**
436 * Specifies the daily snapshot options specified for the Elasticsearch domain.
437 */
438 Options: SnapshotOptions;
439 /**
440 * Specifies the status of a daily automated snapshot.
441 */
442 Status: OptionStatus;
443 }
444 export type String = string;
445 export type StringList = String[];
446 export interface Tag {
447 /**
448 * Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
449 */
450 Key: TagKey;
451 /**
452 * 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
453 */
454 Value: TagValue;
455 }
456 export type TagKey = string;
457 export type TagList = Tag[];
458 export type TagValue = string;
459 export type UIntValue = number;
460 export interface UpdateElasticsearchDomainConfigRequest {
461 /**
462 * The name of the Elasticsearch domain that you are updating.
463 */
464 DomainName: DomainName;
465 /**
466 * The type and number of instances to instantiate for the domain cluster.
467 */
468 ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
469 /**
470 * Specify the type and size of the EBS volume that you want to use.
471 */
472 EBSOptions?: EBSOptions;
473 /**
474 * Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
475 */
476 SnapshotOptions?: SnapshotOptions;
477 /**
478 * 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.
479 */
480 AdvancedOptions?: AdvancedOptions;
481 /**
482 * IAM access policy as a JSON-formatted string.
483 */
484 AccessPolicies?: PolicyDocument;
485 }
486 export interface UpdateElasticsearchDomainConfigResponse {
487 /**
488 * The status of the updated Elasticsearch domain.
489 */
490 DomainConfig: ElasticsearchDomainConfig;
491 }
492 export type UpdateTimestamp = Date;
493 export type VolumeType = "standard"|"gp2"|"io1"|string;
494 /**
495 * 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.
496 */
497 export type apiVersion = "2015-01-01"|"latest"|string;
498 export interface ClientApiVersions {
499 /**
500 * 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.
501 */
502 apiVersion?: apiVersion;
503 }
504 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
505 }
506 export = ES;