ListDomainNames
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.
- EngineType
-
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.
- DomainNames
-
The names of all OpenSearch Service domains owned by the current user and their respective engine types.
Type: Array of DomainInfo objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- BaseException
-
An error occurred while processing the request.
HTTP Status Code: 400
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
