{
"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>",
Loading ...