# Amazon Elasticsearch Service API

> Amazon Elasticsearch Service API on Apizie: 50 endpoints (Allows the destination domain owner to accept an inbound cross-cluster search connection request., Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An…, Associates a package with an Amazon ES domain., Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-es/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-es`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-es
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-es/openapi.json

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…

## Endpoints

### Allows the destination domain owner to accept an inbound cross-cluster search connection request.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/accept-inbound-cross-cluster-search-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The id of the inbound connection that you want to accept. |

### Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/add-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Associates a package with an Amazon ES domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/associate-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value. |
| DomainName | string | yes | Name of the domain that you want to associate the package with. |

### Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/authorize-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain to provide access to. |
| body | object | yes | JSON request body |

### Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/cancel-elasticsearch-service-software-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/create-elasticsearch-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new cross-cluster search connection from a source domain to a destination domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/create-outbound-cross-cluster-search-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Create a package for use with Amazon ES domains.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/create-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | Identifier to allow retrieval of paginated results. |

### Creates an Amazon OpenSearch Service-managed VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/create-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-elasticsearch-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the Elasticsearch domain for which you want information. |

### Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-elasticsearch-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the Elasticsearch domain that you want to permanently delete. |

### Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-elasticsearch-service-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-inbound-cross-cluster-search-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The id of the inbound connection that you want to permanently delete. |

### Allows the source domain owner to delete an existing outbound cross-cluster search connection.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-outbound-cross-cluster-search-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The id of the outbound connection that you want to permanently delete. |

### Delete the package.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Internal ID of the package that you want to delete. Use DescribePackages to find this value. |

### Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/delete-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| VpcEndpointId | string | yes | The unique identifier of the endpoint to be deleted. |

### Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-domain-auto-tunes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | Specifies the domain name for which you want Auto-Tune action details. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns information about the current blue/green deployment happening on a domain, including a change ID,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-domain-change-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The domain you want to get the progress information about. |
| changeid | string | no | The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns… |

### Provides cluster configuration information about the specified Elasticsearch domain, such as the state,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-elasticsearch-domain-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The Elasticsearch domain that you want to get information about. |

### Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/update-elasticsearch-domain-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the Elasticsearch domain that you are updating. |
| body | object | yes | JSON request body |

### Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-elasticsearch-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-elasticsearch-instance-type-limits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| domainName | string | no | DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for… |
| InstanceType | string | yes | The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed. |
| ElasticsearchVersion | string | yes | Version of Elasticsearch for which Limits are needed. |

### Lists all the inbound cross-cluster search connections for a destination domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-inbound-cross-cluster-search-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists all the outbound cross-cluster search connections for a source domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-outbound-cross-cluster-search-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Lists available reserved Elasticsearch instance offerings.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-reserved-elasticsearch-instance-offerings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| offeringId | string | no | The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation… |
| maxResults | integer | no | Set this value to limit the number of results returned. If not specified, defaults to 100. |
| nextToken | string | no | NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns information about reserved Elasticsearch instances for this account.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-reserved-elasticsearch-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| reservationId | string | no | The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved… |
| maxResults | integer | no | Set this value to limit the number of results returned. If not specified, defaults to 100. |
| nextToken | string | no | NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/describe-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Dissociates a package from the Amazon ES domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/dissociate-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value. |
| DomainName | string | yes | Name of the domain that you want to associate the package with. |

### Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/get-compatible-elasticsearch-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| domainName | string | no |  |

### Returns a list of versions of the package, along with their creation time and commit message.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/get-package-version-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Returns an audit history of versions of the package. |
| maxResults | integer | no | Limits results to a maximum number of versions. |
| nextToken | string | no | Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Retrieves the complete history of the last 10 upgrades that were performed on the domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/get-upgrade-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes |  |
| maxResults | integer | no |  |
| nextToken | string | no |  |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/get-upgrade-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes |  |

### Returns the name of all Elasticsearch domains owned by the current user's account.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-domain-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| engineType | string | no | Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'. |

### Lists all Amazon ES domains associated with the package.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-domains-for-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | The package for which to list domains. |
| maxResults | integer | no | Limits results to a maximum number of domains. |
| nextToken | string | no | Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### List all Elasticsearch instance types that are supported for given ElasticsearchVersion
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-elasticsearch-instance-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ElasticsearchVersion | string | yes | Version of Elasticsearch for which list of supported elasticsearch instance types are needed. |
| domainName | string | no | DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of… |
| maxResults | integer | no | Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored. |
| nextToken | string | no | NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### List all supported Elasticsearch versions
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-elasticsearch-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored. |
| nextToken | string | no |  |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all packages associated with the Amazon ES domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-packages-for-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain for which you want to list associated packages. |
| maxResults | integer | no | Limits results to a maximum number of packages. |
| nextToken | string | no | Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns all tags for the given Elasticsearch domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view. |

### Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain to retrieve access information for. |
| nextToken | string | no | Provides an identifier to allow retrieval of paginated results. |

### Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-es/list-vpc-endpoints-for-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | Name of the ElasticSearch domain whose VPC endpoints are to be listed. |
| nextToken | string | no | Provides an identifier to allow retrieval of paginated results. |

### Allows you to purchase reserved Elasticsearch instances.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/purchase-reserved-elasticsearch-instance-offering` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Allows the destination domain owner to reject an inbound cross-cluster search connection request.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/reject-inbound-cross-cluster-search-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The id of the inbound connection that you want to reject. |

### Removes the specified set of tags from the specified Elasticsearch domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/remove-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/revoke-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain. |
| body | object | yes | JSON request body |

### Schedules a service software update for an Amazon ES domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/start-elasticsearch-service-software-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Updates a package for use with Amazon ES domains.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/update-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/update-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/upgrade-elasticsearch-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-es/accept-inbound-cross-cluster-search-connection" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Elasticsearch Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-es/accept-inbound-cross-cluster-search-connection with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Elasticsearch Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Elasticsearch Service itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Elasticsearch Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-es.

### What is the status of the Amazon Elasticsearch Service API?
Needs your own provider key (bring your own key)