Amazon OpenSearch Service

2021/09/17 - Amazon OpenSearch Service - 1 updated api methods

Changes  This release adds an optional parameter in the ListDomainNames API to filter domains based on the engine type (OpenSearch/Elasticsearch).

ListDomainNames (updated) Link ΒΆ
Changes (response)
{'DomainNames': {'EngineType': 'OpenSearch | Elasticsearch'}}

Returns the names of all domains owned by the current user's account.

See also: AWS API Documentation

Request Syntax

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

string

param EngineType

Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

rtype

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) --

          The DomainName .

        • EngineType (string) --

          Specifies the EngineType of the domain.