Amazon Web Services, Inc.

Amazon Elasticsearch Service

Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 52

  • PUTAccept inbound cross cluster search connection/2015-01-01/es/ccs/inboundConnection/:CrossClusterSearchConnectionId/acceptAllows the destination domain owner to accept an inbound cross-cluster search connection request.
  • GETList tags/2015-01-01/tags?arn=stringReturns all tags for the given Elasticsearch domain.
  • POSTAdd tags/2015-01-01/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…
  • POSTAssociate package/2015-01-01/packages/associate/:PackageID/:DomainNameAssociates a package with an Amazon ES domain.
  • POSTAuthorize vpc endpoint access/2015-01-01/es/domain/:DomainName/authorizeVpcEndpointAccessProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  • POSTCancel domain config change/2015-01-01/es/domain/:DomainName/config/cancelCancels a pending configuration change on an Amazon OpenSearch Service domain.
  • POSTCancel elasticsearch service software update/2015-01-01/es/serviceSoftwareUpdate/cancelCancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the…
  • POSTCreate elasticsearch domain/2015-01-01/es/domainCreates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide .
  • POSTCreate outbound cross cluster search connection/2015-01-01/es/ccs/outboundConnectionCreates a new cross-cluster search connection from a source domain to a destination domain.
  • POSTCreate package/2015-01-01/packagesCreate a package for use with Amazon ES domains.
  • GETList vpc endpoints/2015-01-01/es/vpcEndpoints?nextToken=stringRetrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
  • POSTCreate vpc endpoint/2015-01-01/es/vpcEndpointsCreates an Amazon OpenSearch Service-managed VPC endpoint.
  • GETDescribe elasticsearch domain/2015-01-01/es/domain/:DomainNameReturns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
  • DELETEDelete elasticsearch domain/2015-01-01/es/domain/:DomainNamePermanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
  • DELETEDelete elasticsearch service role/2015-01-01/es/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…
  • DELETEDelete inbound cross cluster search connection/2015-01-01/es/ccs/inboundConnection/:CrossClusterSearchConnectionIdAllows the destination domain owner to delete an existing inbound cross-cluster search connection.
  • DELETEDelete outbound cross cluster search connection/2015-01-01/es/ccs/outboundConnection/:CrossClusterSearchConnectionIdAllows the source domain owner to delete an existing outbound cross-cluster search connection.
  • DELETEDelete package/2015-01-01/packages/:PackageIDDelete the package.
  • DELETEDelete vpc endpoint/2015-01-01/es/vpcEndpoints/:VpcEndpointIdDeletes an Amazon OpenSearch Service-managed interface VPC endpoint.
  • GETDescribe domain auto tunes/2015-01-01/es/domain/:DomainName/autoTunes?maxResults=0&nextToken=stringProvides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
  • GETDescribe domain change progress/2015-01-01/es/domain/:DomainName/progress?changeid=stringReturns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
  • GETDescribe elasticsearch domain config/2015-01-01/es/domain/:DomainName/configProvides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for…
  • POSTUpdate elasticsearch domain config/2015-01-01/es/domain/:DomainName/configModifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
  • POSTDescribe elasticsearch domains/2015-01-01/es/domain-infoReturns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
  • GETDescribe elasticsearch instance type limits/2015-01-01/es/instanceTypeLimits/:ElasticsearchVersion/:InstanceType?domainName=stringDescribe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits…
  • POSTDescribe inbound cross cluster search connections/2015-01-01/es/ccs/inboundConnection/searchLists all the inbound cross-cluster search connections for a destination domain.
  • POSTDescribe outbound cross cluster search connections/2015-01-01/es/ccs/outboundConnection/searchLists all the outbound cross-cluster search connections for a source domain.
  • POSTDescribe packages/2015-01-01/packages/describeDescribes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
  • GETDescribe reserved elasticsearch instance offerings/2015-01-01/es/reservedInstanceOfferings?offeringId=string&maxResults=0&nextToken=stringLists available reserved Elasticsearch instance offerings.
  • GETDescribe reserved elasticsearch instances/2015-01-01/es/reservedInstances?reservationId=string&maxResults=0&nextToken=stringReturns information about reserved Elasticsearch instances for this account.
  • POSTDescribe vpc endpoints/2015-01-01/es/vpcEndpoints/describeDescribes one or more Amazon OpenSearch Service-managed VPC endpoints.
  • POSTDissociate package/2015-01-01/packages/dissociate/:PackageID/:DomainNameDissociates a package from the Amazon ES domain.
  • GETGet compatible elasticsearch versions/2015-01-01/es/compatibleVersions?domainName=stringReturns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that…
  • GETGet package version history/2015-01-01/packages/:PackageID/history?maxResults=0&nextToken=stringReturns a list of versions of the package, along with their creation time and commit message.
  • GETGet upgrade history/2015-01-01/es/upgradeDomain/:DomainName/history?maxResults=0&nextToken=stringRetrieves the complete history of the last 10 upgrades that were performed on the domain.
  • GETGet upgrade status/2015-01-01/es/upgradeDomain/:DomainName/statusRetrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
  • GETList domain names/2015-01-01/domain?engineType=stringReturns the name of all Elasticsearch domains owned by the current user's account.
  • GETList domains for package/2015-01-01/packages/:PackageID/domains?maxResults=0&nextToken=stringLists all Amazon ES domains associated with the package.
  • GETList elasticsearch instance types/2015-01-01/es/instanceTypes/:ElasticsearchVersion?domainName=string&maxResults=0&nextToken=stringList all Elasticsearch instance types that are supported for given ElasticsearchVersion
  • GETList elasticsearch versions/2015-01-01/es/versions?maxResults=0&nextToken=stringList all supported Elasticsearch versions
  • GETList packages for domain/2015-01-01/domain/:DomainName/packages?maxResults=0&nextToken=stringLists all packages associated with the Amazon ES domain.
  • GETList vpc endpoint access/2015-01-01/es/domain/:DomainName/listVpcEndpointAccess?nextToken=stringRetrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  • GETList vpc endpoints for domain/2015-01-01/es/domain/:DomainName/vpcEndpoints?nextToken=stringRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
  • POSTPurchase reserved elasticsearch instance offering/2015-01-01/es/purchaseReservedInstanceOfferingAllows you to purchase reserved Elasticsearch instances.
  • PUTReject inbound cross cluster search connection/2015-01-01/es/ccs/inboundConnection/:CrossClusterSearchConnectionId/rejectAllows the destination domain owner to reject an inbound cross-cluster search connection request.
  • POSTRemove tags/2015-01-01/tags-removalRemoves the specified set of tags from the specified Elasticsearch domain.
  • POSTRevoke vpc endpoint access/2015-01-01/es/domain/:DomainName/revokeVpcEndpointAccessRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
  • POSTStart elasticsearch service software update/2015-01-01/es/serviceSoftwareUpdate/startSchedules a service software update for an Amazon ES domain.
  • POSTUpdate clone/2015-01-01/es/domain/:DomainName/cloneManages a cloned blue/green upgrade that is in progress on a domain. Use it to shift a percentage of search traffic to the cloned cluster, to cut over to the…
  • POSTUpdate package/2015-01-01/packages/updateUpdates a package for use with Amazon ES domains.
  • POSTUpdate vpc endpoint/2015-01-01/es/vpcEndpoints/updateModifies an Amazon OpenSearch Service-managed interface VPC endpoint.
  • POSTUpgrade elasticsearch domain/2015-01-01/es/upgradeDomainAllows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

API details

Base URL
https://es.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
52 operations on 48 pathsPOST 24GET 20DELETE 6PUT 2
Description format
AWS Smithy model, API version 2015-01-01

How to test the Amazon Elasticsearch Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Elasticsearch Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept inbound cross cluster search connection” (PUT /2015-01-01/es/ccs/inboundConnection/:CrossClusterSearchConnectionId/accept), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Elasticsearch Service?

Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample… It is listed under Developer tools and has 52 endpoints.

Who publishes the Amazon Elasticsearch Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Elasticsearch Service?

Requests go to https://es.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Elasticsearch Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Elasticsearch Service have?

52 operations on 48 paths (24 POST, 20 GET, 6 DELETE, 2 PUT).

Is forking the Amazon Elasticsearch Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.