api-2.json 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. {
  2. "version":"2.0",
  3. "metadata":{
  4. "apiVersion":"2015-01-01",
  5. "endpointPrefix":"es",
  6. "protocol":"rest-json",
  7. "serviceFullName":"Amazon Elasticsearch Service",
  8. "signatureVersion":"v4"
  9. },
  10. "operations":{
  11. "AddTags":{
  12. "name":"AddTags",
  13. "http":{
  14. "method":"POST",
  15. "requestUri":"/2015-01-01/tags"
  16. },
  17. "input":{"shape":"AddTagsRequest"},
  18. "errors":[
  19. {"shape":"BaseException"},
  20. {"shape":"LimitExceededException"},
  21. {"shape":"ValidationException"},
  22. {"shape":"InternalException"}
  23. ]
  24. },
  25. "CreateElasticsearchDomain":{
  26. "name":"CreateElasticsearchDomain",
  27. "http":{
  28. "method":"POST",
  29. "requestUri":"/2015-01-01/es/domain"
  30. },
  31. "input":{"shape":"CreateElasticsearchDomainRequest"},
  32. "output":{"shape":"CreateElasticsearchDomainResponse"},
  33. "errors":[
  34. {"shape":"BaseException"},
  35. {"shape":"DisabledOperationException"},
  36. {"shape":"InternalException"},
  37. {"shape":"InvalidTypeException"},
  38. {"shape":"LimitExceededException"},
  39. {"shape":"ResourceAlreadyExistsException"},
  40. {"shape":"ValidationException"}
  41. ]
  42. },
  43. "DeleteElasticsearchDomain":{
  44. "name":"DeleteElasticsearchDomain",
  45. "http":{
  46. "method":"DELETE",
  47. "requestUri":"/2015-01-01/es/domain/{DomainName}"
  48. },
  49. "input":{"shape":"DeleteElasticsearchDomainRequest"},
  50. "output":{"shape":"DeleteElasticsearchDomainResponse"},
  51. "errors":[
  52. {"shape":"BaseException"},
  53. {"shape":"InternalException"},
  54. {"shape":"ResourceNotFoundException"},
  55. {"shape":"ValidationException"}
  56. ]
  57. },
  58. "DescribeElasticsearchDomain":{
  59. "name":"DescribeElasticsearchDomain",
  60. "http":{
  61. "method":"GET",
  62. "requestUri":"/2015-01-01/es/domain/{DomainName}"
  63. },
  64. "input":{"shape":"DescribeElasticsearchDomainRequest"},
  65. "output":{"shape":"DescribeElasticsearchDomainResponse"},
  66. "errors":[
  67. {"shape":"BaseException"},
  68. {"shape":"InternalException"},
  69. {"shape":"ResourceNotFoundException"},
  70. {"shape":"ValidationException"}
  71. ]
  72. },
  73. "DescribeElasticsearchDomainConfig":{
  74. "name":"DescribeElasticsearchDomainConfig",
  75. "http":{
  76. "method":"GET",
  77. "requestUri":"/2015-01-01/es/domain/{DomainName}/config"
  78. },
  79. "input":{"shape":"DescribeElasticsearchDomainConfigRequest"},
  80. "output":{"shape":"DescribeElasticsearchDomainConfigResponse"},
  81. "errors":[
  82. {"shape":"BaseException"},
  83. {"shape":"InternalException"},
  84. {"shape":"ResourceNotFoundException"},
  85. {"shape":"ValidationException"}
  86. ]
  87. },
  88. "DescribeElasticsearchDomains":{
  89. "name":"DescribeElasticsearchDomains",
  90. "http":{
  91. "method":"POST",
  92. "requestUri":"/2015-01-01/es/domain-info"
  93. },
  94. "input":{"shape":"DescribeElasticsearchDomainsRequest"},
  95. "output":{"shape":"DescribeElasticsearchDomainsResponse"},
  96. "errors":[
  97. {"shape":"BaseException"},
  98. {"shape":"InternalException"},
  99. {"shape":"ValidationException"}
  100. ]
  101. },
  102. "ListDomainNames":{
  103. "name":"ListDomainNames",
  104. "http":{
  105. "method":"GET",
  106. "requestUri":"/2015-01-01/domain"
  107. },
  108. "output":{"shape":"ListDomainNamesResponse"},
  109. "errors":[
  110. {"shape":"BaseException"},
  111. {"shape":"ValidationException"}
  112. ]
  113. },
  114. "ListTags":{
  115. "name":"ListTags",
  116. "http":{
  117. "method":"GET",
  118. "requestUri":"/2015-01-01/tags/"
  119. },
  120. "input":{"shape":"ListTagsRequest"},
  121. "output":{"shape":"ListTagsResponse"},
  122. "errors":[
  123. {"shape":"BaseException"},
  124. {"shape":"ResourceNotFoundException"},
  125. {"shape":"ValidationException"},
  126. {"shape":"InternalException"}
  127. ]
  128. },
  129. "RemoveTags":{
  130. "name":"RemoveTags",
  131. "http":{
  132. "method":"POST",
  133. "requestUri":"/2015-01-01/tags-removal"
  134. },
  135. "input":{"shape":"RemoveTagsRequest"},
  136. "errors":[
  137. {"shape":"BaseException"},
  138. {"shape":"ValidationException"},
  139. {"shape":"InternalException"}
  140. ]
  141. },
  142. "UpdateElasticsearchDomainConfig":{
  143. "name":"UpdateElasticsearchDomainConfig",
  144. "http":{
  145. "method":"POST",
  146. "requestUri":"/2015-01-01/es/domain/{DomainName}/config"
  147. },
  148. "input":{"shape":"UpdateElasticsearchDomainConfigRequest"},
  149. "output":{"shape":"UpdateElasticsearchDomainConfigResponse"},
  150. "errors":[
  151. {"shape":"BaseException"},
  152. {"shape":"InternalException"},
  153. {"shape":"InvalidTypeException"},
  154. {"shape":"LimitExceededException"},
  155. {"shape":"ResourceNotFoundException"},
  156. {"shape":"ValidationException"}
  157. ]
  158. }
  159. },
  160. "shapes":{
  161. "ARN":{"type":"string"},
  162. "AccessPoliciesStatus":{
  163. "type":"structure",
  164. "required":[
  165. "Options",
  166. "Status"
  167. ],
  168. "members":{
  169. "Options":{"shape":"PolicyDocument"},
  170. "Status":{"shape":"OptionStatus"}
  171. }
  172. },
  173. "AddTagsRequest":{
  174. "type":"structure",
  175. "required":[
  176. "ARN",
  177. "TagList"
  178. ],
  179. "members":{
  180. "ARN":{"shape":"ARN"},
  181. "TagList":{"shape":"TagList"}
  182. }
  183. },
  184. "AdvancedOptions":{
  185. "type":"map",
  186. "key":{"shape":"String"},
  187. "value":{"shape":"String"}
  188. },
  189. "AdvancedOptionsStatus":{
  190. "type":"structure",
  191. "required":[
  192. "Options",
  193. "Status"
  194. ],
  195. "members":{
  196. "Options":{"shape":"AdvancedOptions"},
  197. "Status":{"shape":"OptionStatus"}
  198. }
  199. },
  200. "BaseException":{
  201. "type":"structure",
  202. "members":{
  203. "message":{"shape":"ErrorMessage"}
  204. },
  205. "exception":true
  206. },
  207. "Boolean":{"type":"boolean"},
  208. "CreateElasticsearchDomainRequest":{
  209. "type":"structure",
  210. "required":["DomainName"],
  211. "members":{
  212. "DomainName":{"shape":"DomainName"},
  213. "ElasticsearchVersion":{"shape":"ElasticsearchVersionString"},
  214. "ElasticsearchClusterConfig":{"shape":"ElasticsearchClusterConfig"},
  215. "EBSOptions":{"shape":"EBSOptions"},
  216. "AccessPolicies":{"shape":"PolicyDocument"},
  217. "SnapshotOptions":{"shape":"SnapshotOptions"},
  218. "AdvancedOptions":{"shape":"AdvancedOptions"}
  219. }
  220. },
  221. "CreateElasticsearchDomainResponse":{
  222. "type":"structure",
  223. "members":{
  224. "DomainStatus":{"shape":"ElasticsearchDomainStatus"}
  225. }
  226. },
  227. "DeleteElasticsearchDomainRequest":{
  228. "type":"structure",
  229. "required":["DomainName"],
  230. "members":{
  231. "DomainName":{
  232. "shape":"DomainName",
  233. "location":"uri",
  234. "locationName":"DomainName"
  235. }
  236. }
  237. },
  238. "DeleteElasticsearchDomainResponse":{
  239. "type":"structure",
  240. "members":{
  241. "DomainStatus":{"shape":"ElasticsearchDomainStatus"}
  242. }
  243. },
  244. "DescribeElasticsearchDomainConfigRequest":{
  245. "type":"structure",
  246. "required":["DomainName"],
  247. "members":{
  248. "DomainName":{
  249. "shape":"DomainName",
  250. "location":"uri",
  251. "locationName":"DomainName"
  252. }
  253. }
  254. },
  255. "DescribeElasticsearchDomainConfigResponse":{
  256. "type":"structure",
  257. "required":["DomainConfig"],
  258. "members":{
  259. "DomainConfig":{"shape":"ElasticsearchDomainConfig"}
  260. }
  261. },
  262. "DescribeElasticsearchDomainRequest":{
  263. "type":"structure",
  264. "required":["DomainName"],
  265. "members":{
  266. "DomainName":{
  267. "shape":"DomainName",
  268. "location":"uri",
  269. "locationName":"DomainName"
  270. }
  271. }
  272. },
  273. "DescribeElasticsearchDomainResponse":{
  274. "type":"structure",
  275. "required":["DomainStatus"],
  276. "members":{
  277. "DomainStatus":{"shape":"ElasticsearchDomainStatus"}
  278. }
  279. },
  280. "DescribeElasticsearchDomainsRequest":{
  281. "type":"structure",
  282. "required":["DomainNames"],
  283. "members":{
  284. "DomainNames":{"shape":"DomainNameList"}
  285. }
  286. },
  287. "DescribeElasticsearchDomainsResponse":{
  288. "type":"structure",
  289. "required":["DomainStatusList"],
  290. "members":{
  291. "DomainStatusList":{"shape":"ElasticsearchDomainStatusList"}
  292. }
  293. },
  294. "DisabledOperationException":{
  295. "type":"structure",
  296. "members":{
  297. },
  298. "error":{"httpStatusCode":409},
  299. "exception":true
  300. },
  301. "DomainId":{
  302. "type":"string",
  303. "max":64,
  304. "min":1
  305. },
  306. "DomainInfo":{
  307. "type":"structure",
  308. "members":{
  309. "DomainName":{"shape":"DomainName"}
  310. }
  311. },
  312. "DomainInfoList":{
  313. "type":"list",
  314. "member":{"shape":"DomainInfo"}
  315. },
  316. "DomainName":{
  317. "type":"string",
  318. "max":28,
  319. "min":3,
  320. "pattern":"[a-z][a-z0-9\\-]+"
  321. },
  322. "DomainNameList":{
  323. "type":"list",
  324. "member":{"shape":"DomainName"}
  325. },
  326. "EBSOptions":{
  327. "type":"structure",
  328. "members":{
  329. "EBSEnabled":{"shape":"Boolean"},
  330. "VolumeType":{"shape":"VolumeType"},
  331. "VolumeSize":{"shape":"IntegerClass"},
  332. "Iops":{"shape":"IntegerClass"}
  333. }
  334. },
  335. "EBSOptionsStatus":{
  336. "type":"structure",
  337. "required":[
  338. "Options",
  339. "Status"
  340. ],
  341. "members":{
  342. "Options":{"shape":"EBSOptions"},
  343. "Status":{"shape":"OptionStatus"}
  344. }
  345. },
  346. "ESPartitionInstanceType":{
  347. "type":"string",
  348. "enum":[
  349. "m3.medium.elasticsearch",
  350. "m3.large.elasticsearch",
  351. "m3.xlarge.elasticsearch",
  352. "m3.2xlarge.elasticsearch",
  353. "m4.large.elasticsearch",
  354. "m4.xlarge.elasticsearch",
  355. "m4.2xlarge.elasticsearch",
  356. "m4.4xlarge.elasticsearch",
  357. "m4.10xlarge.elasticsearch",
  358. "t2.micro.elasticsearch",
  359. "t2.small.elasticsearch",
  360. "t2.medium.elasticsearch",
  361. "r3.large.elasticsearch",
  362. "r3.xlarge.elasticsearch",
  363. "r3.2xlarge.elasticsearch",
  364. "r3.4xlarge.elasticsearch",
  365. "r3.8xlarge.elasticsearch",
  366. "i2.xlarge.elasticsearch",
  367. "i2.2xlarge.elasticsearch"
  368. ]
  369. },
  370. "ElasticsearchClusterConfig":{
  371. "type":"structure",
  372. "members":{
  373. "InstanceType":{"shape":"ESPartitionInstanceType"},
  374. "InstanceCount":{"shape":"IntegerClass"},
  375. "DedicatedMasterEnabled":{"shape":"Boolean"},
  376. "ZoneAwarenessEnabled":{"shape":"Boolean"},
  377. "DedicatedMasterType":{"shape":"ESPartitionInstanceType"},
  378. "DedicatedMasterCount":{"shape":"IntegerClass"}
  379. }
  380. },
  381. "ElasticsearchClusterConfigStatus":{
  382. "type":"structure",
  383. "required":[
  384. "Options",
  385. "Status"
  386. ],
  387. "members":{
  388. "Options":{"shape":"ElasticsearchClusterConfig"},
  389. "Status":{"shape":"OptionStatus"}
  390. }
  391. },
  392. "ElasticsearchDomainConfig":{
  393. "type":"structure",
  394. "members":{
  395. "ElasticsearchVersion":{"shape":"ElasticsearchVersionStatus"},
  396. "ElasticsearchClusterConfig":{"shape":"ElasticsearchClusterConfigStatus"},
  397. "EBSOptions":{"shape":"EBSOptionsStatus"},
  398. "AccessPolicies":{"shape":"AccessPoliciesStatus"},
  399. "SnapshotOptions":{"shape":"SnapshotOptionsStatus"},
  400. "AdvancedOptions":{"shape":"AdvancedOptionsStatus"}
  401. }
  402. },
  403. "ElasticsearchDomainStatus":{
  404. "type":"structure",
  405. "required":[
  406. "DomainId",
  407. "DomainName",
  408. "ARN",
  409. "ElasticsearchClusterConfig"
  410. ],
  411. "members":{
  412. "DomainId":{"shape":"DomainId"},
  413. "DomainName":{"shape":"DomainName"},
  414. "ARN":{"shape":"ARN"},
  415. "Created":{"shape":"Boolean"},
  416. "Deleted":{"shape":"Boolean"},
  417. "Endpoint":{"shape":"ServiceUrl"},
  418. "Processing":{"shape":"Boolean"},
  419. "ElasticsearchVersion":{"shape":"ElasticsearchVersionString"},
  420. "ElasticsearchClusterConfig":{"shape":"ElasticsearchClusterConfig"},
  421. "EBSOptions":{"shape":"EBSOptions"},
  422. "AccessPolicies":{"shape":"PolicyDocument"},
  423. "SnapshotOptions":{"shape":"SnapshotOptions"},
  424. "AdvancedOptions":{"shape":"AdvancedOptions"}
  425. }
  426. },
  427. "ElasticsearchDomainStatusList":{
  428. "type":"list",
  429. "member":{"shape":"ElasticsearchDomainStatus"}
  430. },
  431. "ElasticsearchVersionStatus":{
  432. "type":"structure",
  433. "required":[
  434. "Options",
  435. "Status"
  436. ],
  437. "members":{
  438. "Options":{"shape":"ElasticsearchVersionString"},
  439. "Status":{"shape":"OptionStatus"}
  440. }
  441. },
  442. "ElasticsearchVersionString":{"type":"string"},
  443. "ErrorMessage":{"type":"string"},
  444. "IntegerClass":{"type":"integer"},
  445. "InternalException":{
  446. "type":"structure",
  447. "members":{
  448. },
  449. "error":{"httpStatusCode":500},
  450. "exception":true
  451. },
  452. "InvalidTypeException":{
  453. "type":"structure",
  454. "members":{
  455. },
  456. "error":{"httpStatusCode":409},
  457. "exception":true
  458. },
  459. "LimitExceededException":{
  460. "type":"structure",
  461. "members":{
  462. },
  463. "error":{"httpStatusCode":409},
  464. "exception":true
  465. },
  466. "ListDomainNamesResponse":{
  467. "type":"structure",
  468. "members":{
  469. "DomainNames":{"shape":"DomainInfoList"}
  470. }
  471. },
  472. "ListTagsRequest":{
  473. "type":"structure",
  474. "required":["ARN"],
  475. "members":{
  476. "ARN":{
  477. "shape":"ARN",
  478. "location":"querystring",
  479. "locationName":"arn"
  480. }
  481. }
  482. },
  483. "ListTagsResponse":{
  484. "type":"structure",
  485. "members":{
  486. "TagList":{"shape":"TagList"}
  487. }
  488. },
  489. "OptionState":{
  490. "type":"string",
  491. "enum":[
  492. "RequiresIndexDocuments",
  493. "Processing",
  494. "Active"
  495. ]
  496. },
  497. "OptionStatus":{
  498. "type":"structure",
  499. "required":[
  500. "CreationDate",
  501. "UpdateDate",
  502. "State"
  503. ],
  504. "members":{
  505. "CreationDate":{"shape":"UpdateTimestamp"},
  506. "UpdateDate":{"shape":"UpdateTimestamp"},
  507. "UpdateVersion":{"shape":"UIntValue"},
  508. "State":{"shape":"OptionState"},
  509. "PendingDeletion":{"shape":"Boolean"}
  510. }
  511. },
  512. "PolicyDocument":{"type":"string"},
  513. "RemoveTagsRequest":{
  514. "type":"structure",
  515. "required":[
  516. "ARN",
  517. "TagKeys"
  518. ],
  519. "members":{
  520. "ARN":{"shape":"ARN"},
  521. "TagKeys":{"shape":"StringList"}
  522. }
  523. },
  524. "ResourceAlreadyExistsException":{
  525. "type":"structure",
  526. "members":{
  527. },
  528. "error":{"httpStatusCode":409},
  529. "exception":true
  530. },
  531. "ResourceNotFoundException":{
  532. "type":"structure",
  533. "members":{
  534. },
  535. "error":{"httpStatusCode":409},
  536. "exception":true
  537. },
  538. "ServiceUrl":{"type":"string"},
  539. "SnapshotOptions":{
  540. "type":"structure",
  541. "members":{
  542. "AutomatedSnapshotStartHour":{"shape":"IntegerClass"}
  543. }
  544. },
  545. "SnapshotOptionsStatus":{
  546. "type":"structure",
  547. "required":[
  548. "Options",
  549. "Status"
  550. ],
  551. "members":{
  552. "Options":{"shape":"SnapshotOptions"},
  553. "Status":{"shape":"OptionStatus"}
  554. }
  555. },
  556. "String":{"type":"string"},
  557. "StringList":{
  558. "type":"list",
  559. "member":{"shape":"String"}
  560. },
  561. "Tag":{
  562. "type":"structure",
  563. "required":[
  564. "Key",
  565. "Value"
  566. ],
  567. "members":{
  568. "Key":{"shape":"TagKey"},
  569. "Value":{"shape":"TagValue"}
  570. }
  571. },
  572. "TagKey":{
  573. "type":"string",
  574. "max":128,
  575. "min":1
  576. },
  577. "TagList":{
  578. "type":"list",
  579. "member":{"shape":"Tag"}
  580. },
  581. "TagValue":{
  582. "type":"string",
  583. "max":256,
  584. "min":0
  585. },
  586. "UIntValue":{
  587. "type":"integer",
  588. "min":0
  589. },
  590. "UpdateElasticsearchDomainConfigRequest":{
  591. "type":"structure",
  592. "required":["DomainName"],
  593. "members":{
  594. "DomainName":{
  595. "shape":"DomainName",
  596. "location":"uri",
  597. "locationName":"DomainName"
  598. },
  599. "ElasticsearchClusterConfig":{"shape":"ElasticsearchClusterConfig"},
  600. "EBSOptions":{"shape":"EBSOptions"},
  601. "SnapshotOptions":{"shape":"SnapshotOptions"},
  602. "AdvancedOptions":{"shape":"AdvancedOptions"},
  603. "AccessPolicies":{"shape":"PolicyDocument"}
  604. }
  605. },
  606. "UpdateElasticsearchDomainConfigResponse":{
  607. "type":"structure",
  608. "required":["DomainConfig"],
  609. "members":{
  610. "DomainConfig":{"shape":"ElasticsearchDomainConfig"}
  611. }
  612. },
  613. "UpdateTimestamp":{"type":"timestamp"},
  614. "ValidationException":{
  615. "type":"structure",
  616. "members":{
  617. },
  618. "error":{"httpStatusCode":400},
  619. "exception":true
  620. },
  621. "VolumeType":{
  622. "type":"string",
  623. "enum":[
  624. "standard",
  625. "gp2",
  626. "io1"
  627. ]
  628. }
  629. }
  630. }