ListDomainNames - Amazon OpenSearch Service


Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Request Syntax

GET /2021-01-01/domain?engineType=EngineType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


Filters the output by domain engine type.

Valid Values: OpenSearch | Elasticsearch

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DomainNames": [ { "DomainName": "string", "EngineType": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The names of all OpenSearch Service domains owned by the current user and their respective engine types.

Type: Array of DomainInfo objects


For information about the errors that are common to all actions, see Common Errors.


An error occurred while processing the request.

HTTP Status Code: 400


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400



This example illustrates one usage of ListDomainNames.

Sample Request

GET /2021-01-01/domain HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-domain-names X-Amz-Date: 20240209T223114Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=47e588909eb82143e199bb6e4ec3c0cae11f20e4778fda277d68b0518bca962a

Sample Response

{ "DomainNames":[ { "DomainName":"my-domain-1", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-2", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-3", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-4", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-5", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-6", "EngineType":"OpenSearch" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: