forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathes-2015-01-01.normal.json
929 lines (929 loc) · 42 KB
/
es-2015-01-01.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
{
"version":"2.0",
"metadata":{
"uid":"es-2015-01-01",
"apiVersion":"2015-01-01",
"endpointPrefix":"es",
"protocol":"rest-json",
"serviceFullName":"Amazon Elasticsearch Service",
"signatureVersion":"v4"
},
"operations":{
"AddTags":{
"name":"AddTags",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/tags"
},
"input":{"shape":"AddTagsRequest"},
"errors":[
{"shape":"BaseException"},
{"shape":"LimitExceededException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging\" target=\"_blank\"> Tagging Amazon Elasticsearch Service Domains for more information.</a></p>"
},
"CreateElasticsearchDomain":{
"name":"CreateElasticsearchDomain",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/es/domain"
},
"input":{"shape":"CreateElasticsearchDomainRequest"},
"output":{"shape":"CreateElasticsearchDomainResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"DisabledOperationException"},
{"shape":"InternalException"},
{"shape":"InvalidTypeException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new Elasticsearch domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains\" target=\"_blank\">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>"
},
"DeleteElasticsearchDomain":{
"name":"DeleteElasticsearchDomain",
"http":{
"method":"DELETE",
"requestUri":"/2015-01-01/es/domain/{DomainName}"
},
"input":{"shape":"DeleteElasticsearchDomainRequest"},
"output":{"shape":"DeleteElasticsearchDomainResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.</p>"
},
"DescribeElasticsearchDomain":{
"name":"DescribeElasticsearchDomain",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/domain/{DomainName}"
},
"input":{"shape":"DescribeElasticsearchDomainRequest"},
"output":{"shape":"DescribeElasticsearchDomainResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.</p>"
},
"DescribeElasticsearchDomainConfig":{
"name":"DescribeElasticsearchDomainConfig",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/domain/{DomainName}/config"
},
"input":{"shape":"DescribeElasticsearchDomainConfigRequest"},
"output":{"shape":"DescribeElasticsearchDomainConfigResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.</p>"
},
"DescribeElasticsearchDomains":{
"name":"DescribeElasticsearchDomains",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/es/domain-info"
},
"input":{"shape":"DescribeElasticsearchDomainsRequest"},
"output":{"shape":"DescribeElasticsearchDomainsResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.</p>"
},
"ListDomainNames":{
"name":"ListDomainNames",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/domain"
},
"output":{"shape":"ListDomainNamesResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the name of all Elasticsearch domains owned by the current user's account. </p>"
},
"ListTags":{
"name":"ListTags",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/tags/"
},
"input":{"shape":"ListTagsRequest"},
"output":{"shape":"ListTagsResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>Returns all tags for the given Elasticsearch domain.</p>"
},
"RemoveTags":{
"name":"RemoveTags",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/tags-removal"
},
"input":{"shape":"RemoveTagsRequest"},
"errors":[
{"shape":"BaseException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>Removes the specified set of tags from the specified Elasticsearch domain.</p>"
},
"UpdateElasticsearchDomainConfig":{
"name":"UpdateElasticsearchDomainConfig",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/es/domain/{DomainName}/config"
},
"input":{"shape":"UpdateElasticsearchDomainConfigRequest"},
"output":{"shape":"UpdateElasticsearchDomainConfigResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"InvalidTypeException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </p>"
}
},
"shapes":{
"ARN":{
"type":"string",
"documentation":"<p>The Amazon Resource Name (ARN) of the Elasticsearch domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>"
},
"AccessPoliciesStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"PolicyDocument",
"documentation":"<p>The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\"> Configuring Access Policies</a>for more information.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p>The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>"
}
},
"documentation":"<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>"
},
"AddTagsRequest":{
"type":"structure",
"required":[
"ARN",
"TagList"
],
"members":{
"ARN":{
"shape":"ARN",
"documentation":"<p> Specify the <code>ARN</code> for which you want to add the tags.</p>"
},
"TagList":{
"shape":"TagList",
"documentation":"<p> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>AddTags</a></code> operation. Specify the tags that you want to attach to the Elasticsearch domain.</p>"
},
"AdvancedOptions":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"},
"documentation":"<p> Exposes select native Elasticsearch configuration values from <code>elasticsearch.yml</code>. Currently, the following advanced options are available:</p> <ul> <li>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\">Configuring Advanced Options</a>.</p>"
},
"AdvancedOptionsStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"AdvancedOptions",
"documentation":"<p> Specifies the status of advanced options for the specified Elasticsearch domain.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p> Specifies the status of <code>OptionStatus</code> for advanced options for the specified Elasticsearch domain.</p>"
}
},
"documentation":"<p> Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:</p> <ul> <li>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\">Configuring Advanced Options</a>.</p>"
},
"BaseException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>A description of the error.</p>"
}
},
"documentation":"<p>An error occurred while processing the request.</p>",
"exception":true
},
"Boolean":{"type":"boolean"},
"CreateElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>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).</p>"
},
"ElasticsearchVersion":{
"shape":"ElasticsearchVersionString",
"documentation":"<p>String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains\" target=\"_blank\">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>"
},
"ElasticsearchClusterConfig":{
"shape":"ElasticsearchClusterConfig",
"documentation":"<p>Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. </p>"
},
"EBSOptions":{
"shape":"EBSOptions",
"documentation":"<p>Options to enable, disable and specify the type and size of EBS storage volumes. </p>"
},
"AccessPolicies":{
"shape":"PolicyDocument",
"documentation":"<p> IAM access policy as a JSON-formatted string.</p>"
},
"SnapshotOptions":{
"shape":"SnapshotOptions",
"documentation":"<p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. </p>"
},
"AdvancedOptions":{
"shape":"AdvancedOptions",
"documentation":"<p> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</p>"
}
}
},
"CreateElasticsearchDomainResponse":{
"type":"structure",
"members":{
"DomainStatus":{
"shape":"ElasticsearchDomainStatus",
"documentation":"<p>The status of the newly created Elasticsearch domain. </p>"
}
},
"documentation":"<p>The result of a <code>CreateElasticsearchDomain</code> operation. Contains the status of the newly created Elasticsearch domain.</p>"
},
"DeleteElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of the Elasticsearch domain that you want to permanently delete.</p>",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p>Container for the parameters to the <code><a>DeleteElasticsearchDomain</a></code> operation. Specifies the name of the Elasticsearch domain that you want to delete.</p>"
},
"DeleteElasticsearchDomainResponse":{
"type":"structure",
"members":{
"DomainStatus":{
"shape":"ElasticsearchDomainStatus",
"documentation":"<p>The status of the Elasticsearch domain being deleted.</p>"
}
},
"documentation":"<p>The result of a <code>DeleteElasticsearchDomain</code> request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.</p>"
},
"DescribeElasticsearchDomainConfigRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The Elasticsearch domain that you want to get information about.</p>",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p> Container for the parameters to the <code>DescribeElasticsearchDomainConfig</code> operation. Specifies the domain name for which you want configuration information.</p>"
},
"DescribeElasticsearchDomainConfigResponse":{
"type":"structure",
"required":["DomainConfig"],
"members":{
"DomainConfig":{
"shape":"ElasticsearchDomainConfig",
"documentation":"<p>The configuration information of the domain requested in the <code>DescribeElasticsearchDomainConfig</code> request.</p>"
}
},
"documentation":"<p>The result of a <code>DescribeElasticsearchDomainConfig</code> request. Contains the configuration information of the requested domain.</p>"
},
"DescribeElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of the Elasticsearch domain for which you want information.</p>",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p>Container for the parameters to the <code><a>DescribeElasticsearchDomain</a></code> operation.</p>"
},
"DescribeElasticsearchDomainResponse":{
"type":"structure",
"required":["DomainStatus"],
"members":{
"DomainStatus":{
"shape":"ElasticsearchDomainStatus",
"documentation":"<p>The current status of the Elasticsearch domain.</p>"
}
},
"documentation":"<p>The result of a <code>DescribeElasticsearchDomain</code> request. Contains the status of the domain specified in the request.</p>"
},
"DescribeElasticsearchDomainsRequest":{
"type":"structure",
"required":["DomainNames"],
"members":{
"DomainNames":{
"shape":"DomainNameList",
"documentation":"<p>The Elasticsearch domains for which you want information.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>DescribeElasticsearchDomains</a></code> operation. By default, the API returns the status of all Elasticsearch domains.</p>"
},
"DescribeElasticsearchDomainsResponse":{
"type":"structure",
"required":["DomainStatusList"],
"members":{
"DomainStatusList":{
"shape":"ElasticsearchDomainStatusList",
"documentation":"<p>The status of the domains requested in the <code>DescribeElasticsearchDomains</code> request.</p>"
}
},
"documentation":"<p>The result of a <code>DescribeElasticsearchDomains</code> request. Contains the status of the specified domains or all domains owned by the account.</p>"
},
"DisabledOperationException":{
"type":"structure",
"members":{
},
"documentation":"<p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"DomainId":{
"type":"string",
"documentation":"<p>Unique identifier for an Elasticsearch domain.</p>",
"max":64,
"min":1
},
"DomainInfo":{
"type":"structure",
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p> Specifies the <code>DomainName</code>.</p>"
}
}
},
"DomainInfoList":{
"type":"list",
"member":{"shape":"DomainInfo"},
"documentation":"<p> Contains the list of Elasticsearch domain information.</p>"
},
"DomainName":{
"type":"string",
"documentation":"<p>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).</p>",
"max":28,
"min":3,
"pattern":"[a-z][a-z0-9\\-]+"
},
"DomainNameList":{
"type":"list",
"member":{"shape":"DomainName"},
"documentation":"<p>A list of Elasticsearch domain names.</p>"
},
"EBSOptions":{
"type":"structure",
"members":{
"EBSEnabled":{
"shape":"Boolean",
"documentation":"<p>Specifies whether EBS-based storage is enabled.</p>"
},
"VolumeType":{
"shape":"VolumeType",
"documentation":"<p> Specifies the volume type for EBS-based storage.</p>"
},
"VolumeSize":{
"shape":"IntegerClass",
"documentation":"<p> Integer to specify the size of an EBS volume.</p>"
},
"Iops":{
"shape":"IntegerClass",
"documentation":"<p>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</p>"
}
},
"documentation":"<p>Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\"> Configuring EBS-based Storage</a>.</p>"
},
"EBSOptionsStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"EBSOptions",
"documentation":"<p> Specifies the EBS options for the specified Elasticsearch domain.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p> Specifies the status of the EBS options for the specified Elasticsearch domain.</p>"
}
},
"documentation":"<p> Status of the EBS options for the specified Elasticsearch domain.</p>"
},
"ESPartitionInstanceType":{
"type":"string",
"enum":[
"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"
]
},
"ElasticsearchClusterConfig":{
"type":"structure",
"members":{
"InstanceType":{
"shape":"ESPartitionInstanceType",
"documentation":"<p>The instance type for an Elasticsearch cluster.</p>"
},
"InstanceCount":{
"shape":"IntegerClass",
"documentation":"<p>The number of instances in the specified domain cluster.</p>"
},
"DedicatedMasterEnabled":{
"shape":"Boolean",
"documentation":"<p>A boolean value to indicate whether a dedicated master node is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes\" target=\"_blank\">About Dedicated Master Nodes</a> for more information.</p>"
},
"ZoneAwarenessEnabled":{
"shape":"Boolean",
"documentation":"<p>A boolean value to indicate whether zone awareness is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness\" target=\"_blank\">About Zone Awareness</a> for more information.</p>"
},
"DedicatedMasterType":{
"shape":"ESPartitionInstanceType",
"documentation":"<p>The instance type for a dedicated master node.</p>"
},
"DedicatedMasterCount":{
"shape":"IntegerClass",
"documentation":"<p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>"
}
},
"documentation":"<p>Specifies the configuration for the domain cluster, such as the type and number of instances.</p>"
},
"ElasticsearchClusterConfigStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"ElasticsearchClusterConfig",
"documentation":"<p> Specifies the cluster configuration for the specified Elasticsearch domain.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p> Specifies the status of the configuration for the specified Elasticsearch domain.</p>"
}
},
"documentation":"<p> Specifies the configuration status for the specified Elasticsearch domain.</p>"
},
"ElasticsearchDomainConfig":{
"type":"structure",
"members":{
"ElasticsearchVersion":{
"shape":"ElasticsearchVersionStatus",
"documentation":"<p>String of format X.Y to specify version for the Elasticsearch domain.</p>"
},
"ElasticsearchClusterConfig":{
"shape":"ElasticsearchClusterConfigStatus",
"documentation":"<p>Specifies the <code>ElasticsearchClusterConfig</code> for the Elasticsearch domain.</p>"
},
"EBSOptions":{
"shape":"EBSOptionsStatus",
"documentation":"<p>Specifies the <code>EBSOptions</code> for the Elasticsearch domain.</p>"
},
"AccessPolicies":{
"shape":"AccessPoliciesStatus",
"documentation":"<p>IAM access policy as a JSON-formatted string.</p>"
},
"SnapshotOptions":{
"shape":"SnapshotOptionsStatus",
"documentation":"<p>Specifies the <code>SnapshotOptions</code> for the Elasticsearch domain.</p>"
},
"AdvancedOptions":{
"shape":"AdvancedOptionsStatus",
"documentation":"<p>Specifies the <code>AdvancedOptions</code> for the domain. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuring Advanced Options</a> for more information.</p>"
}
},
"documentation":"<p>The configuration of an Elasticsearch domain.</p>"
},
"ElasticsearchDomainStatus":{
"type":"structure",
"required":[
"DomainId",
"DomainName",
"ARN",
"ElasticsearchClusterConfig"
],
"members":{
"DomainId":{
"shape":"DomainId",
"documentation":"<p>The unique identifier for the specified Elasticsearch domain.</p>"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>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).</p>"
},
"ARN":{
"shape":"ARN",
"documentation":"<p>The Amazon resource name (ARN) of an Elasticsearch domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>"
},
"Created":{
"shape":"Boolean",
"documentation":"<p>The domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.</p>"
},
"Deleted":{
"shape":"Boolean",
"documentation":"<p>The domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.</p>"
},
"Endpoint":{
"shape":"ServiceUrl",
"documentation":"<p>The Elasticsearch domain endpoint that you use to submit index and search requests.</p>"
},
"Processing":{
"shape":"Boolean",
"documentation":"<p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>"
},
"ElasticsearchVersion":{"shape":"ElasticsearchVersionString"},
"ElasticsearchClusterConfig":{
"shape":"ElasticsearchClusterConfig",
"documentation":"<p>The type and number of instances in the domain cluster.</p>"
},
"EBSOptions":{
"shape":"EBSOptions",
"documentation":"<p>The <code>EBSOptions</code> for the specified domain. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\">Configuring EBS-based Storage</a> for more information.</p>"
},
"AccessPolicies":{
"shape":"PolicyDocument",
"documentation":"<p> IAM access policy as a JSON-formatted string.</p>"
},
"SnapshotOptions":{
"shape":"SnapshotOptions",
"documentation":"<p>Specifies the status of the <code>SnapshotOptions</code></p>"
},
"AdvancedOptions":{
"shape":"AdvancedOptions",
"documentation":"<p>Specifies the status of the <code>AdvancedOptions</code></p>"
}
},
"documentation":"<p>The current status of an Elasticsearch domain.</p>"
},
"ElasticsearchDomainStatusList":{
"type":"list",
"member":{"shape":"ElasticsearchDomainStatus"},
"documentation":"<p>A list that contains the status of each requested Elasticsearch domain.</p>"
},
"ElasticsearchVersionStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"ElasticsearchVersionString",
"documentation":"<p> Specifies the Elasticsearch version for the specified Elasticsearch domain.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p> Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.</p>"
}
},
"documentation":"<p> Status of the Elasticsearch version options for the specified Elasticsearch domain.</p>"
},
"ElasticsearchVersionString":{"type":"string"},
"ErrorMessage":{"type":"string"},
"IntegerClass":{"type":"integer"},
"InternalException":{
"type":"structure",
"members":{
},
"documentation":"<p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidTypeException":{
"type":"structure",
"members":{
},
"documentation":"<p>An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
},
"documentation":"<p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ListDomainNamesResponse":{
"type":"structure",
"members":{
"DomainNames":{
"shape":"DomainInfoList",
"documentation":"<p>List of Elasticsearch domain names.</p>"
}
},
"documentation":"<p>The result of a <code>ListDomainNames</code> operation. Contains the names of all Elasticsearch domains owned by this account.</p>"
},
"ListTagsRequest":{
"type":"structure",
"required":["ARN"],
"members":{
"ARN":{
"shape":"ARN",
"documentation":"<p> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</p>",
"location":"querystring",
"locationName":"arn"
}
},
"documentation":"<p>Container for the parameters to the <code><a>ListTags</a></code> operation. Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view are attached.</p>"
},
"ListTagsResponse":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p> List of <code>Tag</code> for the requested Elasticsearch domain.</p>"
}
},
"documentation":"<p>The result of a <code>ListTags</code> operation. Contains tags for all requested Elasticsearch domains.</p>"
},
"OptionState":{
"type":"string",
"documentation":"<p>The state of a requested change. One of the following:</p> <ul> <li>Processing: The request change is still in-process.</li> <li>Active: The request change is processed and deployed to the Elasticsearch domain.</li> </ul>",
"enum":[
"RequiresIndexDocuments",
"Processing",
"Active"
]
},
"OptionStatus":{
"type":"structure",
"required":[
"CreationDate",
"UpdateDate",
"State"
],
"members":{
"CreationDate":{
"shape":"UpdateTimestamp",
"documentation":"<p>Timestamp which tells the creation date for the entity.</p>"
},
"UpdateDate":{
"shape":"UpdateTimestamp",
"documentation":"<p>Timestamp which tells the last updated time for the entity.</p>"
},
"UpdateVersion":{
"shape":"UIntValue",
"documentation":"<p>Specifies the latest version for the entity.</p>"
},
"State":{
"shape":"OptionState",
"documentation":"<p>Provides the <code>OptionState</code> for the Elasticsearch domain.</p>"
},
"PendingDeletion":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the Elasticsearch domain is being deleted.</p>"
}
},
"documentation":"<p>Provides the current status of the entity.</p>"
},
"PolicyDocument":{
"type":"string",
"documentation":"<p>Access policy rules for an Elasticsearch domain service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\">Configuring Access Policies</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>"
},
"RemoveTagsRequest":{
"type":"structure",
"required":[
"ARN",
"TagKeys"
],
"members":{
"ARN":{
"shape":"ARN",
"documentation":"<p>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</p>"
},
"TagKeys":{
"shape":"StringList",
"documentation":"<p>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>RemoveTags</a></code> operation. Specify the <code>ARN</code> for the Elasticsearch domain from which you want to remove the specified <code>TagKey</code>.</p>"
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>An exception for creating a resource that already exists. Gives http status code of 400.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ServiceUrl":{
"type":"string",
"documentation":"<p>The endpoint to which service requests are submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code>.</p>"
},
"SnapshotOptions":{
"type":"structure",
"members":{
"AutomatedSnapshotStartHour":{
"shape":"IntegerClass",
"documentation":"<p>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</p>"
}
},
"documentation":"<p>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</p>"
},
"SnapshotOptionsStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{
"shape":"SnapshotOptions",
"documentation":"<p>Specifies the daily snapshot options specified for the Elasticsearch domain.</p>"
},
"Status":{
"shape":"OptionStatus",
"documentation":"<p>Specifies the status of a daily automated snapshot.</p>"
}
},
"documentation":"<p>Status of a daily automated snapshot.</p>"
},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>Specifies the <code>TagKey</code>, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>Specifies the <code>TagValue</code>, 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 <code>project : Trinity</code> and <code>cost-center : Trinity</code></p>"
}
},
"documentation":"<p>Specifies a key value pair for a resource tag.</p>"
},
"TagKey":{
"type":"string",
"documentation":"<p>A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.</p>",
"max":128,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"documentation":"<p>A list of <code>Tag</code> </p>"
},
"TagValue":{
"type":"string",
"documentation":"<p>A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.</p>",
"max":256,
"min":0
},
"UIntValue":{
"type":"integer",
"min":0
},
"UpdateElasticsearchDomainConfigRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of the Elasticsearch domain that you are updating. </p>",
"location":"uri",
"locationName":"DomainName"
},
"ElasticsearchClusterConfig":{
"shape":"ElasticsearchClusterConfig",
"documentation":"<p>The type and number of instances to instantiate for the domain cluster.</p>"
},
"EBSOptions":{
"shape":"EBSOptions",
"documentation":"<p>Specify the type and size of the EBS volume that you want to use. </p>"
},
"SnapshotOptions":{
"shape":"SnapshotOptions",
"documentation":"<p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>"
},
"AdvancedOptions":{
"shape":"AdvancedOptions",
"documentation":"<p>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</p>"
},
"AccessPolicies":{
"shape":"PolicyDocument",
"documentation":"<p>IAM access policy as a JSON-formatted string.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>UpdateElasticsearchDomain</a></code> operation. Specifies the type and number of instances in the domain cluster.</p>"
},
"UpdateElasticsearchDomainConfigResponse":{
"type":"structure",
"required":["DomainConfig"],
"members":{
"DomainConfig":{
"shape":"ElasticsearchDomainConfig",
"documentation":"<p>The status of the updated Elasticsearch domain. </p>"
}
},
"documentation":"<p>The result of an <code>UpdateElasticsearchDomain</code> request. Contains the status of the Elasticsearch domain being updated.</p>"
},
"UpdateTimestamp":{"type":"timestamp"},
"ValidationException":{
"type":"structure",
"members":{
},
"documentation":"<p>An exception for missing / invalid input fields. Gives http status code of 400.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"VolumeType":{
"type":"string",
"documentation":"<p> The type of EBS volume, standard, gp2, or io1. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\">Configuring EBS-based Storage</a>for more information.</p>",
"enum":[
"standard",
"gp2",
"io1"
]
}
},
"documentation":"<fullname>Amazon Elasticsearch Configuration Service</fullname> <p>Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.</p> <p>The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions\" target=\"_blank\">Regions and Endpoints</a>.</p>"
}