{ "version": "2.0", "service": "Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", "operations": { "AddTags": "

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

", "CreateElasticsearchDomain": "

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

", "DeleteElasticsearchDomain": "

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

", "DescribeElasticsearchDomain": "

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

", "DescribeElasticsearchDomainConfig": "

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

", "DescribeElasticsearchDomains": "

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

", "ListDomainNames": "

Returns the name of all Elasticsearch domains owned by the current user's account.

", "ListTags": "

Returns all tags for the given Elasticsearch domain.

", "RemoveTags": "

Removes the specified set of tags from the specified Elasticsearch domain.

", "UpdateElasticsearchDomainConfig": "

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

" }, "shapes": { "ARN": { "base": "

The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

", "refs": { "AddTagsRequest$ARN": "

Specify the ARN for which you want to add the tags.

", "ElasticsearchDomainStatus$ARN": "

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

", "ListTagsRequest$ARN": "

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

", "RemoveTagsRequest$ARN": "

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

" } }, "AccessPoliciesStatus": { "base": "

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

", "refs": { "ElasticsearchDomainConfig$AccessPolicies": "

IAM access policy as a JSON-formatted string.

" } }, "AddTagsRequest": { "base": "

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

", "refs": { } }, "AdvancedOptions": { "base": "

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

", "refs": { "AdvancedOptionsStatus$Options": "

Specifies the status of advanced options for the specified Elasticsearch domain.

", "CreateElasticsearchDomainRequest$AdvancedOptions": "

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

", "ElasticsearchDomainStatus$AdvancedOptions": "

Specifies the status of the AdvancedOptions

", "UpdateElasticsearchDomainConfigRequest$AdvancedOptions": "

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

" } }, "AdvancedOptionsStatus": { "base": "

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

", "refs": { "ElasticsearchDomainConfig$AdvancedOptions": "

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

" } }, "BaseException": { "base": "

An error occurred while processing the request.

", "refs": { } }, "Boolean": { "base": null, "refs": { "EBSOptions$EBSEnabled": "

Specifies whether EBS-based storage is enabled.

", "ElasticsearchClusterConfig$DedicatedMasterEnabled": "

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

", "ElasticsearchClusterConfig$ZoneAwarenessEnabled": "

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

", "ElasticsearchDomainStatus$Created": "

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

", "ElasticsearchDomainStatus$Deleted": "

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

", "ElasticsearchDomainStatus$Processing": "

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

", "OptionStatus$PendingDeletion": "

Indicates whether the Elasticsearch domain is being deleted.

" } }, "CreateElasticsearchDomainRequest": { "base": null, "refs": { } }, "CreateElasticsearchDomainResponse": { "base": "

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

", "refs": { } }, "DeleteElasticsearchDomainRequest": { "base": "

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

", "refs": { } }, "DeleteElasticsearchDomainResponse": { "base": "

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

", "refs": { } }, "DescribeElasticsearchDomainConfigRequest": { "base": "

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

", "refs": { } }, "DescribeElasticsearchDomainConfigResponse": { "base": "

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

", "refs": { } }, "DescribeElasticsearchDomainRequest": { "base": "

Container for the parameters to the DescribeElasticsearchDomain operation.

", "refs": { } }, "DescribeElasticsearchDomainResponse": { "base": "

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

", "refs": { } }, "DescribeElasticsearchDomainsRequest": { "base": "

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

", "refs": { } }, "DescribeElasticsearchDomainsResponse": { "base": "

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

", "refs": { } }, "DisabledOperationException": { "base": "

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

", "refs": { } }, "DomainId": { "base": "

Unique identifier for an Elasticsearch domain.

", "refs": { "ElasticsearchDomainStatus$DomainId": "

The unique identifier for the specified Elasticsearch domain.

" } }, "DomainInfo": { "base": null, "refs": { "DomainInfoList$member": null } }, "DomainInfoList": { "base": "

Contains the list of Elasticsearch domain information.

", "refs": { "ListDomainNamesResponse$DomainNames": "

List of Elasticsearch domain names.

" } }, "DomainName": { "base": "

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).

", "refs": { "CreateElasticsearchDomainRequest$DomainName": "

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).

", "DeleteElasticsearchDomainRequest$DomainName": "

The name of the Elasticsearch domain that you want to permanently delete.

", "DescribeElasticsearchDomainConfigRequest$DomainName": "

The Elasticsearch domain that you want to get information about.

", "DescribeElasticsearchDomainRequest$DomainName": "

The name of the Elasticsearch domain for which you want information.

", "DomainInfo$DomainName": "

Specifies the DomainName.

", "DomainNameList$member": null, "ElasticsearchDomainStatus$DomainName": "

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).

", "UpdateElasticsearchDomainConfigRequest$DomainName": "

The name of the Elasticsearch domain that you are updating.

" } }, "DomainNameList": { "base": "

A list of Elasticsearch domain names.

", "refs": { "DescribeElasticsearchDomainsRequest$DomainNames": "

The Elasticsearch domains for which you want information.

" } }, "EBSOptions": { "base": "

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

", "refs": { "CreateElasticsearchDomainRequest$EBSOptions": "

Options to enable, disable and specify the type and size of EBS storage volumes.

", "EBSOptionsStatus$Options": "

Specifies the EBS options for the specified Elasticsearch domain.

", "ElasticsearchDomainStatus$EBSOptions": "

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

", "UpdateElasticsearchDomainConfigRequest$EBSOptions": "

Specify the type and size of the EBS volume that you want to use.

" } }, "EBSOptionsStatus": { "base": "

Status of the EBS options for the specified Elasticsearch domain.

", "refs": { "ElasticsearchDomainConfig$EBSOptions": "

Specifies the EBSOptions for the Elasticsearch domain.

" } }, "ESPartitionInstanceType": { "base": null, "refs": { "ElasticsearchClusterConfig$InstanceType": "

The instance type for an Elasticsearch cluster.

", "ElasticsearchClusterConfig$DedicatedMasterType": "

The instance type for a dedicated master node.

" } }, "ElasticsearchClusterConfig": { "base": "

Specifies the configuration for the domain cluster, such as the type and number of instances.

", "refs": { "CreateElasticsearchDomainRequest$ElasticsearchClusterConfig": "

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

", "ElasticsearchClusterConfigStatus$Options": "

Specifies the cluster configuration for the specified Elasticsearch domain.

", "ElasticsearchDomainStatus$ElasticsearchClusterConfig": "

The type and number of instances in the domain cluster.

", "UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig": "

The type and number of instances to instantiate for the domain cluster.

" } }, "ElasticsearchClusterConfigStatus": { "base": "

Specifies the configuration status for the specified Elasticsearch domain.

", "refs": { "ElasticsearchDomainConfig$ElasticsearchClusterConfig": "

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

" } }, "ElasticsearchDomainConfig": { "base": "

The configuration of an Elasticsearch domain.

", "refs": { "DescribeElasticsearchDomainConfigResponse$DomainConfig": "

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

", "UpdateElasticsearchDomainConfigResponse$DomainConfig": "

The status of the updated Elasticsearch domain.

" } }, "ElasticsearchDomainStatus": { "base": "

The current status of an Elasticsearch domain.

", "refs": { "CreateElasticsearchDomainResponse$DomainStatus": "

The status of the newly created Elasticsearch domain.

", "DeleteElasticsearchDomainResponse$DomainStatus": "

The status of the Elasticsearch domain being deleted.

", "DescribeElasticsearchDomainResponse$DomainStatus": "

The current status of the Elasticsearch domain.

", "ElasticsearchDomainStatusList$member": null } }, "ElasticsearchDomainStatusList": { "base": "

A list that contains the status of each requested Elasticsearch domain.

", "refs": { "DescribeElasticsearchDomainsResponse$DomainStatusList": "

The status of the domains requested in the DescribeElasticsearchDomains request.

" } }, "ElasticsearchVersionStatus": { "base": "

Status of the Elasticsearch version options for the specified Elasticsearch domain.

", "refs": { "ElasticsearchDomainConfig$ElasticsearchVersion": "

String of format X.Y to specify version for the Elasticsearch domain.

" } }, "ElasticsearchVersionString": { "base": null, "refs": { "CreateElasticsearchDomainRequest$ElasticsearchVersion": "

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

", "ElasticsearchDomainStatus$ElasticsearchVersion": null, "ElasticsearchVersionStatus$Options": "

Specifies the Elasticsearch version for the specified Elasticsearch domain.

" } }, "ErrorMessage": { "base": null, "refs": { "BaseException$message": "

A description of the error.

" } }, "IntegerClass": { "base": null, "refs": { "EBSOptions$VolumeSize": "

Integer to specify the size of an EBS volume.

", "EBSOptions$Iops": "

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

", "ElasticsearchClusterConfig$InstanceCount": "

The number of instances in the specified domain cluster.

", "ElasticsearchClusterConfig$DedicatedMasterCount": "

Total number of dedicated master nodes, active and on standby, for the cluster.

", "SnapshotOptions$AutomatedSnapshotStartHour": "

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

" } }, "InternalException": { "base": "

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.

", "refs": { } }, "InvalidTypeException": { "base": "

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

", "refs": { } }, "LimitExceededException": { "base": "

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

", "refs": { } }, "ListDomainNamesResponse": { "base": "

The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

", "refs": { } }, "ListTagsRequest": { "base": "

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

", "refs": { } }, "ListTagsResponse": { "base": "

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

", "refs": { } }, "OptionState": { "base": "

The state of a requested change. One of the following:

", "refs": { "OptionStatus$State": "

Provides the OptionState for the Elasticsearch domain.

" } }, "OptionStatus": { "base": "

Provides the current status of the entity.

", "refs": { "AccessPoliciesStatus$Status": "

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

", "AdvancedOptionsStatus$Status": "

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

", "EBSOptionsStatus$Status": "

Specifies the status of the EBS options for the specified Elasticsearch domain.

", "ElasticsearchClusterConfigStatus$Status": "

Specifies the status of the configuration for the specified Elasticsearch domain.

", "ElasticsearchVersionStatus$Status": "

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

", "SnapshotOptionsStatus$Status": "

Specifies the status of a daily automated snapshot.

" } }, "PolicyDocument": { "base": "

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

", "refs": { "AccessPoliciesStatus$Options": "

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

", "CreateElasticsearchDomainRequest$AccessPolicies": "

IAM access policy as a JSON-formatted string.

", "ElasticsearchDomainStatus$AccessPolicies": "

IAM access policy as a JSON-formatted string.

", "UpdateElasticsearchDomainConfigRequest$AccessPolicies": "

IAM access policy as a JSON-formatted string.

" } }, "RemoveTagsRequest": { "base": "

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

", "refs": { } }, "ResourceAlreadyExistsException": { "base": "

An exception for creating a resource that already exists. Gives http status code of 400.

", "refs": { } }, "ResourceNotFoundException": { "base": "

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

", "refs": { } }, "ServiceUrl": { "base": "

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

", "refs": { "ElasticsearchDomainStatus$Endpoint": "

The Elasticsearch domain endpoint that you use to submit index and search requests.

" } }, "SnapshotOptions": { "base": "

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

", "refs": { "CreateElasticsearchDomainRequest$SnapshotOptions": "

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

", "ElasticsearchDomainStatus$SnapshotOptions": "

Specifies the status of the SnapshotOptions

", "SnapshotOptionsStatus$Options": "

Specifies the daily snapshot options specified for the Elasticsearch domain.

", "UpdateElasticsearchDomainConfigRequest$SnapshotOptions": "

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

" } }, "SnapshotOptionsStatus": { "base": "

Status of a daily automated snapshot.

", "refs": { "ElasticsearchDomainConfig$SnapshotOptions": "

Specifies the SnapshotOptions for the Elasticsearch domain.

" } }, "String": { "base": null, "refs": { "AdvancedOptions$key": null, "AdvancedOptions$value": null, "StringList$member": null } }, "StringList": { "base": null, "refs": { "RemoveTagsRequest$TagKeys": "

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

" } }, "Tag": { "base": "

Specifies a key value pair for a resource tag.

", "refs": { "TagList$member": null } }, "TagKey": { "base": "

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.

", "refs": { "Tag$Key": "

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

" } }, "TagList": { "base": "

A list of Tag

", "refs": { "AddTagsRequest$TagList": "

List of Tag that need to be added for the Elasticsearch domain.

", "ListTagsResponse$TagList": "

List of Tag for the requested Elasticsearch domain.

" } }, "TagValue": { "base": "

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.

", "refs": { "Tag$Value": "

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

" } }, "UIntValue": { "base": null, "refs": { "OptionStatus$UpdateVersion": "

Specifies the latest version for the entity.

" } }, "UpdateElasticsearchDomainConfigRequest": { "base": "

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

", "refs": { } }, "UpdateElasticsearchDomainConfigResponse": { "base": "

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

", "refs": { } }, "UpdateTimestamp": { "base": null, "refs": { "OptionStatus$CreationDate": "

Timestamp which tells the creation date for the entity.

", "OptionStatus$UpdateDate": "

Timestamp which tells the last updated time for the entity.

" } }, "ValidationException": { "base": "

An exception for missing / invalid input fields. Gives http status code of 400.

", "refs": { } }, "VolumeType": { "base": "

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

", "refs": { "EBSOptions$VolumeType": "

Specifies the volume type for EBS-based storage.

" } } } }