Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Returns the name of all Elasticsearch domains owned by the current user's account.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
list-domain-names
[--engine-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--engine-type
(string)
Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
Possible values:
OpenSearch
Elasticsearch
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list all domains
The following list-domain-names
example provides a quick summary of all domains in the region.
aws es list-domain-names
Output:
{
"DomainNames": [{
"DomainName": "cli-example-1"
},
{
"DomainName": "cli-example-2"
}
]
}
For more information, see Creating and Managing Amazon Elasticsearch Service Domains in the Amazon Elasticsearch Service Developer Guide.
DomainNames -> (list)
List of domain names and respective engine types.
(structure)
DomainName -> (string)
Specifies theDomainName
.EngineType -> (string)
Specifies theEngineType
of the domain.