docs-2.json 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416
  1. {
  2. "version": "2.0",
  3. "service": "<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>",
  4. "operations": {
  5. "AddTags": "<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>",
  6. "CreateElasticsearchDomain": "<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>",
  7. "DeleteElasticsearchDomain": "<p>Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.</p>",
  8. "DescribeElasticsearchDomain": "<p>Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.</p>",
  9. "DescribeElasticsearchDomainConfig": "<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>",
  10. "DescribeElasticsearchDomains": "<p>Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.</p>",
  11. "ListDomainNames": "<p>Returns the name of all Elasticsearch domains owned by the current user's account. </p>",
  12. "ListTags": "<p>Returns all tags for the given Elasticsearch domain.</p>",
  13. "RemoveTags": "<p>Removes the specified set of tags from the specified Elasticsearch domain.</p>",
  14. "UpdateElasticsearchDomainConfig": "<p>Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </p>"
  15. },
  16. "shapes": {
  17. "ARN": {
  18. "base": "<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>",
  19. "refs": {
  20. "AddTagsRequest$ARN": "<p> Specify the <code>ARN</code> for which you want to add the tags.</p>",
  21. "ElasticsearchDomainStatus$ARN": "<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>",
  22. "ListTagsRequest$ARN": "<p> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</p>",
  23. "RemoveTagsRequest$ARN": "<p>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</p>"
  24. }
  25. },
  26. "AccessPoliciesStatus": {
  27. "base": "<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>",
  28. "refs": {
  29. "ElasticsearchDomainConfig$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>"
  30. }
  31. },
  32. "AddTagsRequest": {
  33. "base": "<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>",
  34. "refs": {
  35. }
  36. },
  37. "AdvancedOptions": {
  38. "base": "<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>",
  39. "refs": {
  40. "AdvancedOptionsStatus$Options": "<p> Specifies the status of advanced options for the specified Elasticsearch domain.</p>",
  41. "CreateElasticsearchDomainRequest$AdvancedOptions": "<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>",
  42. "ElasticsearchDomainStatus$AdvancedOptions": "<p>Specifies the status of the <code>AdvancedOptions</code></p>",
  43. "UpdateElasticsearchDomainConfigRequest$AdvancedOptions": "<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>"
  44. }
  45. },
  46. "AdvancedOptionsStatus": {
  47. "base": "<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>",
  48. "refs": {
  49. "ElasticsearchDomainConfig$AdvancedOptions": "<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>"
  50. }
  51. },
  52. "BaseException": {
  53. "base": "<p>An error occurred while processing the request.</p>",
  54. "refs": {
  55. }
  56. },
  57. "Boolean": {
  58. "base": null,
  59. "refs": {
  60. "EBSOptions$EBSEnabled": "<p>Specifies whether EBS-based storage is enabled.</p>",
  61. "ElasticsearchClusterConfig$DedicatedMasterEnabled": "<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>",
  62. "ElasticsearchClusterConfig$ZoneAwarenessEnabled": "<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>",
  63. "ElasticsearchDomainStatus$Created": "<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>",
  64. "ElasticsearchDomainStatus$Deleted": "<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>",
  65. "ElasticsearchDomainStatus$Processing": "<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>",
  66. "OptionStatus$PendingDeletion": "<p>Indicates whether the Elasticsearch domain is being deleted.</p>"
  67. }
  68. },
  69. "CreateElasticsearchDomainRequest": {
  70. "base": null,
  71. "refs": {
  72. }
  73. },
  74. "CreateElasticsearchDomainResponse": {
  75. "base": "<p>The result of a <code>CreateElasticsearchDomain</code> operation. Contains the status of the newly created Elasticsearch domain.</p>",
  76. "refs": {
  77. }
  78. },
  79. "DeleteElasticsearchDomainRequest": {
  80. "base": "<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>",
  81. "refs": {
  82. }
  83. },
  84. "DeleteElasticsearchDomainResponse": {
  85. "base": "<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>",
  86. "refs": {
  87. }
  88. },
  89. "DescribeElasticsearchDomainConfigRequest": {
  90. "base": "<p> Container for the parameters to the <code>DescribeElasticsearchDomainConfig</code> operation. Specifies the domain name for which you want configuration information.</p>",
  91. "refs": {
  92. }
  93. },
  94. "DescribeElasticsearchDomainConfigResponse": {
  95. "base": "<p>The result of a <code>DescribeElasticsearchDomainConfig</code> request. Contains the configuration information of the requested domain.</p>",
  96. "refs": {
  97. }
  98. },
  99. "DescribeElasticsearchDomainRequest": {
  100. "base": "<p>Container for the parameters to the <code><a>DescribeElasticsearchDomain</a></code> operation.</p>",
  101. "refs": {
  102. }
  103. },
  104. "DescribeElasticsearchDomainResponse": {
  105. "base": "<p>The result of a <code>DescribeElasticsearchDomain</code> request. Contains the status of the domain specified in the request.</p>",
  106. "refs": {
  107. }
  108. },
  109. "DescribeElasticsearchDomainsRequest": {
  110. "base": "<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>",
  111. "refs": {
  112. }
  113. },
  114. "DescribeElasticsearchDomainsResponse": {
  115. "base": "<p>The result of a <code>DescribeElasticsearchDomains</code> request. Contains the status of the specified domains or all domains owned by the account.</p>",
  116. "refs": {
  117. }
  118. },
  119. "DisabledOperationException": {
  120. "base": "<p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>",
  121. "refs": {
  122. }
  123. },
  124. "DomainId": {
  125. "base": "<p>Unique identifier for an Elasticsearch domain.</p>",
  126. "refs": {
  127. "ElasticsearchDomainStatus$DomainId": "<p>The unique identifier for the specified Elasticsearch domain.</p>"
  128. }
  129. },
  130. "DomainInfo": {
  131. "base": null,
  132. "refs": {
  133. "DomainInfoList$member": null
  134. }
  135. },
  136. "DomainInfoList": {
  137. "base": "<p> Contains the list of Elasticsearch domain information.</p>",
  138. "refs": {
  139. "ListDomainNamesResponse$DomainNames": "<p>List of Elasticsearch domain names.</p>"
  140. }
  141. },
  142. "DomainName": {
  143. "base": "<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>",
  144. "refs": {
  145. "CreateElasticsearchDomainRequest$DomainName": "<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>",
  146. "DeleteElasticsearchDomainRequest$DomainName": "<p>The name of the Elasticsearch domain that you want to permanently delete.</p>",
  147. "DescribeElasticsearchDomainConfigRequest$DomainName": "<p>The Elasticsearch domain that you want to get information about.</p>",
  148. "DescribeElasticsearchDomainRequest$DomainName": "<p>The name of the Elasticsearch domain for which you want information.</p>",
  149. "DomainInfo$DomainName": "<p> Specifies the <code>DomainName</code>.</p>",
  150. "DomainNameList$member": null,
  151. "ElasticsearchDomainStatus$DomainName": "<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>",
  152. "UpdateElasticsearchDomainConfigRequest$DomainName": "<p>The name of the Elasticsearch domain that you are updating. </p>"
  153. }
  154. },
  155. "DomainNameList": {
  156. "base": "<p>A list of Elasticsearch domain names.</p>",
  157. "refs": {
  158. "DescribeElasticsearchDomainsRequest$DomainNames": "<p>The Elasticsearch domains for which you want information.</p>"
  159. }
  160. },
  161. "EBSOptions": {
  162. "base": "<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>",
  163. "refs": {
  164. "CreateElasticsearchDomainRequest$EBSOptions": "<p>Options to enable, disable and specify the type and size of EBS storage volumes. </p>",
  165. "EBSOptionsStatus$Options": "<p> Specifies the EBS options for the specified Elasticsearch domain.</p>",
  166. "ElasticsearchDomainStatus$EBSOptions": "<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>",
  167. "UpdateElasticsearchDomainConfigRequest$EBSOptions": "<p>Specify the type and size of the EBS volume that you want to use. </p>"
  168. }
  169. },
  170. "EBSOptionsStatus": {
  171. "base": "<p> Status of the EBS options for the specified Elasticsearch domain.</p>",
  172. "refs": {
  173. "ElasticsearchDomainConfig$EBSOptions": "<p>Specifies the <code>EBSOptions</code> for the Elasticsearch domain.</p>"
  174. }
  175. },
  176. "ESPartitionInstanceType": {
  177. "base": null,
  178. "refs": {
  179. "ElasticsearchClusterConfig$InstanceType": "<p>The instance type for an Elasticsearch cluster.</p>",
  180. "ElasticsearchClusterConfig$DedicatedMasterType": "<p>The instance type for a dedicated master node.</p>"
  181. }
  182. },
  183. "ElasticsearchClusterConfig": {
  184. "base": "<p>Specifies the configuration for the domain cluster, such as the type and number of instances.</p>",
  185. "refs": {
  186. "CreateElasticsearchDomainRequest$ElasticsearchClusterConfig": "<p>Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. </p>",
  187. "ElasticsearchClusterConfigStatus$Options": "<p> Specifies the cluster configuration for the specified Elasticsearch domain.</p>",
  188. "ElasticsearchDomainStatus$ElasticsearchClusterConfig": "<p>The type and number of instances in the domain cluster.</p>",
  189. "UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig": "<p>The type and number of instances to instantiate for the domain cluster.</p>"
  190. }
  191. },
  192. "ElasticsearchClusterConfigStatus": {
  193. "base": "<p> Specifies the configuration status for the specified Elasticsearch domain.</p>",
  194. "refs": {
  195. "ElasticsearchDomainConfig$ElasticsearchClusterConfig": "<p>Specifies the <code>ElasticsearchClusterConfig</code> for the Elasticsearch domain.</p>"
  196. }
  197. },
  198. "ElasticsearchDomainConfig": {
  199. "base": "<p>The configuration of an Elasticsearch domain.</p>",
  200. "refs": {
  201. "DescribeElasticsearchDomainConfigResponse$DomainConfig": "<p>The configuration information of the domain requested in the <code>DescribeElasticsearchDomainConfig</code> request.</p>",
  202. "UpdateElasticsearchDomainConfigResponse$DomainConfig": "<p>The status of the updated Elasticsearch domain. </p>"
  203. }
  204. },
  205. "ElasticsearchDomainStatus": {
  206. "base": "<p>The current status of an Elasticsearch domain.</p>",
  207. "refs": {
  208. "CreateElasticsearchDomainResponse$DomainStatus": "<p>The status of the newly created Elasticsearch domain. </p>",
  209. "DeleteElasticsearchDomainResponse$DomainStatus": "<p>The status of the Elasticsearch domain being deleted.</p>",
  210. "DescribeElasticsearchDomainResponse$DomainStatus": "<p>The current status of the Elasticsearch domain.</p>",
  211. "ElasticsearchDomainStatusList$member": null
  212. }
  213. },
  214. "ElasticsearchDomainStatusList": {
  215. "base": "<p>A list that contains the status of each requested Elasticsearch domain.</p>",
  216. "refs": {
  217. "DescribeElasticsearchDomainsResponse$DomainStatusList": "<p>The status of the domains requested in the <code>DescribeElasticsearchDomains</code> request.</p>"
  218. }
  219. },
  220. "ElasticsearchVersionStatus": {
  221. "base": "<p> Status of the Elasticsearch version options for the specified Elasticsearch domain.</p>",
  222. "refs": {
  223. "ElasticsearchDomainConfig$ElasticsearchVersion": "<p>String of format X.Y to specify version for the Elasticsearch domain.</p>"
  224. }
  225. },
  226. "ElasticsearchVersionString": {
  227. "base": null,
  228. "refs": {
  229. "CreateElasticsearchDomainRequest$ElasticsearchVersion": "<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>",
  230. "ElasticsearchDomainStatus$ElasticsearchVersion": null,
  231. "ElasticsearchVersionStatus$Options": "<p> Specifies the Elasticsearch version for the specified Elasticsearch domain.</p>"
  232. }
  233. },
  234. "ErrorMessage": {
  235. "base": null,
  236. "refs": {
  237. "BaseException$message": "<p>A description of the error.</p>"
  238. }
  239. },
  240. "IntegerClass": {
  241. "base": null,
  242. "refs": {
  243. "EBSOptions$VolumeSize": "<p> Integer to specify the size of an EBS volume.</p>",
  244. "EBSOptions$Iops": "<p>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</p>",
  245. "ElasticsearchClusterConfig$InstanceCount": "<p>The number of instances in the specified domain cluster.</p>",
  246. "ElasticsearchClusterConfig$DedicatedMasterCount": "<p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>",
  247. "SnapshotOptions$AutomatedSnapshotStartHour": "<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>"
  248. }
  249. },
  250. "InternalException": {
  251. "base": "<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>",
  252. "refs": {
  253. }
  254. },
  255. "InvalidTypeException": {
  256. "base": "<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>",
  257. "refs": {
  258. }
  259. },
  260. "LimitExceededException": {
  261. "base": "<p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>",
  262. "refs": {
  263. }
  264. },
  265. "ListDomainNamesResponse": {
  266. "base": "<p>The result of a <code>ListDomainNames</code> operation. Contains the names of all Elasticsearch domains owned by this account.</p>",
  267. "refs": {
  268. }
  269. },
  270. "ListTagsRequest": {
  271. "base": "<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>",
  272. "refs": {
  273. }
  274. },
  275. "ListTagsResponse": {
  276. "base": "<p>The result of a <code>ListTags</code> operation. Contains tags for all requested Elasticsearch domains.</p>",
  277. "refs": {
  278. }
  279. },
  280. "OptionState": {
  281. "base": "<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>",
  282. "refs": {
  283. "OptionStatus$State": "<p>Provides the <code>OptionState</code> for the Elasticsearch domain.</p>"
  284. }
  285. },
  286. "OptionStatus": {
  287. "base": "<p>Provides the current status of the entity.</p>",
  288. "refs": {
  289. "AccessPoliciesStatus$Status": "<p>The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>",
  290. "AdvancedOptionsStatus$Status": "<p> Specifies the status of <code>OptionStatus</code> for advanced options for the specified Elasticsearch domain.</p>",
  291. "EBSOptionsStatus$Status": "<p> Specifies the status of the EBS options for the specified Elasticsearch domain.</p>",
  292. "ElasticsearchClusterConfigStatus$Status": "<p> Specifies the status of the configuration for the specified Elasticsearch domain.</p>",
  293. "ElasticsearchVersionStatus$Status": "<p> Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.</p>",
  294. "SnapshotOptionsStatus$Status": "<p>Specifies the status of a daily automated snapshot.</p>"
  295. }
  296. },
  297. "PolicyDocument": {
  298. "base": "<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>",
  299. "refs": {
  300. "AccessPoliciesStatus$Options": "<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>",
  301. "CreateElasticsearchDomainRequest$AccessPolicies": "<p> IAM access policy as a JSON-formatted string.</p>",
  302. "ElasticsearchDomainStatus$AccessPolicies": "<p> IAM access policy as a JSON-formatted string.</p>",
  303. "UpdateElasticsearchDomainConfigRequest$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>"
  304. }
  305. },
  306. "RemoveTagsRequest": {
  307. "base": "<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>",
  308. "refs": {
  309. }
  310. },
  311. "ResourceAlreadyExistsException": {
  312. "base": "<p>An exception for creating a resource that already exists. Gives http status code of 400.</p>",
  313. "refs": {
  314. }
  315. },
  316. "ResourceNotFoundException": {
  317. "base": "<p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>",
  318. "refs": {
  319. }
  320. },
  321. "ServiceUrl": {
  322. "base": "<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>",
  323. "refs": {
  324. "ElasticsearchDomainStatus$Endpoint": "<p>The Elasticsearch domain endpoint that you use to submit index and search requests.</p>"
  325. }
  326. },
  327. "SnapshotOptions": {
  328. "base": "<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>",
  329. "refs": {
  330. "CreateElasticsearchDomainRequest$SnapshotOptions": "<p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. </p>",
  331. "ElasticsearchDomainStatus$SnapshotOptions": "<p>Specifies the status of the <code>SnapshotOptions</code></p>",
  332. "SnapshotOptionsStatus$Options": "<p>Specifies the daily snapshot options specified for the Elasticsearch domain.</p>",
  333. "UpdateElasticsearchDomainConfigRequest$SnapshotOptions": "<p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>"
  334. }
  335. },
  336. "SnapshotOptionsStatus": {
  337. "base": "<p>Status of a daily automated snapshot.</p>",
  338. "refs": {
  339. "ElasticsearchDomainConfig$SnapshotOptions": "<p>Specifies the <code>SnapshotOptions</code> for the Elasticsearch domain.</p>"
  340. }
  341. },
  342. "String": {
  343. "base": null,
  344. "refs": {
  345. "AdvancedOptions$key": null,
  346. "AdvancedOptions$value": null,
  347. "StringList$member": null
  348. }
  349. },
  350. "StringList": {
  351. "base": null,
  352. "refs": {
  353. "RemoveTagsRequest$TagKeys": "<p>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</p>"
  354. }
  355. },
  356. "Tag": {
  357. "base": "<p>Specifies a key value pair for a resource tag.</p>",
  358. "refs": {
  359. "TagList$member": null
  360. }
  361. },
  362. "TagKey": {
  363. "base": "<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>",
  364. "refs": {
  365. "Tag$Key": "<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>"
  366. }
  367. },
  368. "TagList": {
  369. "base": "<p>A list of <code>Tag</code> </p>",
  370. "refs": {
  371. "AddTagsRequest$TagList": "<p> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </p>",
  372. "ListTagsResponse$TagList": "<p> List of <code>Tag</code> for the requested Elasticsearch domain.</p>"
  373. }
  374. },
  375. "TagValue": {
  376. "base": "<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>",
  377. "refs": {
  378. "Tag$Value": "<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>"
  379. }
  380. },
  381. "UIntValue": {
  382. "base": null,
  383. "refs": {
  384. "OptionStatus$UpdateVersion": "<p>Specifies the latest version for the entity.</p>"
  385. }
  386. },
  387. "UpdateElasticsearchDomainConfigRequest": {
  388. "base": "<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>",
  389. "refs": {
  390. }
  391. },
  392. "UpdateElasticsearchDomainConfigResponse": {
  393. "base": "<p>The result of an <code>UpdateElasticsearchDomain</code> request. Contains the status of the Elasticsearch domain being updated.</p>",
  394. "refs": {
  395. }
  396. },
  397. "UpdateTimestamp": {
  398. "base": null,
  399. "refs": {
  400. "OptionStatus$CreationDate": "<p>Timestamp which tells the creation date for the entity.</p>",
  401. "OptionStatus$UpdateDate": "<p>Timestamp which tells the last updated time for the entity.</p>"
  402. }
  403. },
  404. "ValidationException": {
  405. "base": "<p>An exception for missing / invalid input fields. Gives http status code of 400.</p>",
  406. "refs": {
  407. }
  408. },
  409. "VolumeType": {
  410. "base": "<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>",
  411. "refs": {
  412. "EBSOptions$VolumeType": "<p> Specifies the volume type for EBS-based storage.</p>"
  413. }
  414. }
  415. }
  416. }