aws es

Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs. 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

Subcommands

NameDescription
accept-inbound-cross-cluster-search-connectionAllows the destination domain owner to accept an inbound cross-cluster search connection request
add-tagsAttaches 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
associate-packageAssociates a package with an Amazon ES domain
cancel-elasticsearch-service-software-updateCancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state
create-elasticsearch-domainCreates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide
create-outbound-cross-cluster-search-connectionCreates a new cross-cluster search connection from a source domain to a destination domain
create-packageCreate a package for use with Amazon ES domains
delete-elasticsearch-domainPermanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered
delete-elasticsearch-service-roleDeletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains
delete-inbound-cross-cluster-search-connectionAllows the destination domain owner to delete an existing inbound cross-cluster search connection
delete-outbound-cross-cluster-search-connectionAllows the source domain owner to delete an existing outbound cross-cluster search connection
delete-packageDelete the package
describe-domain-auto-tunesProvides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date
describe-elasticsearch-domainReturns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN
describe-elasticsearch-domain-configProvides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options
describe-elasticsearch-domainsReturns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN
describe-elasticsearch-instance-type-limitsDescribe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying
describe-inbound-cross-cluster-search-connectionsLists all the inbound cross-cluster search connections for a destination domain
describe-outbound-cross-cluster-search-connectionsLists all the outbound cross-cluster search connections for a source domain
describe-packagesDescribes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination
describe-reserved-elasticsearch-instance-offeringsLists available reserved Elasticsearch instance offerings
describe-reserved-elasticsearch-instancesReturns information about reserved Elasticsearch instances for this account
dissociate-packageDissociates a package from the Amazon ES domain
get-compatible-elasticsearch-versionsReturns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain
get-package-version-historyReturns a list of versions of the package, along with their creation time and commit message
get-upgrade-historyRetrieves the complete history of the last 10 upgrades that were performed on the domain
get-upgrade-statusRetrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain
list-domain-namesReturns the name of all Elasticsearch domains owned by the current user's account
list-domains-for-packageLists all Amazon ES domains associated with the package
list-elasticsearch-instance-typesList all Elasticsearch instance types that are supported for given ElasticsearchVersion
list-elasticsearch-versionsList all supported Elasticsearch versions
list-packages-for-domainLists all packages associated with the Amazon ES domain
list-tagsReturns all tags for the given Elasticsearch domain
purchase-reserved-elasticsearch-instance-offeringAllows you to purchase reserved Elasticsearch instances
reject-inbound-cross-cluster-search-connectionAllows the destination domain owner to reject an inbound cross-cluster search connection request
remove-tagsRemoves the specified set of tags from the specified Elasticsearch domain
start-elasticsearch-service-software-updateSchedules a service software update for an Amazon ES domain
update-elasticsearch-domain-configModifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances
update-packageUpdates a package for use with Amazon ES domains
upgrade-elasticsearch-domainAllows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version