ElasticsearchService / Client / list_domain_names

list_domain_names

ElasticsearchService.Client.list_domain_names(**kwargs)

Returns the name of all Elasticsearch domains owned by the current user’s account.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_names(
    EngineType='OpenSearch'|'Elasticsearch'
)

Parameters:

EngineType (string) – Optional parameter to filter the output by domain engine type. Acceptable values are ‘Elasticsearch’ and ‘OpenSearch’.

Return type:

dict

Returns:

Response Syntax

{
    'DomainNames': [
        {
            'DomainName': 'string',
            'EngineType': 'OpenSearch'|'Elasticsearch'
        },
    ]
}

Response Structure

• (dict) –

  The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

  • DomainNames (list) –

    List of domain names and respective engine types.

    • (dict) –

      • DomainName (string) –

        Specifies the DomainName.

      • EngineType (string) –

        Specifies the EngineType of the domain.

Exceptions

• ElasticsearchService.Client.exceptions.BaseException

• ElasticsearchService.Client.exceptions.ValidationException