list_domains_for_package

ElasticsearchService.Client.list_domains_for_package(**kwargs)

Lists all Amazon ES domains associated with the package.

See also: AWS API Documentation

Request Syntax

response = client.list_domains_for_package(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• PackageID (string) --

  [REQUIRED]

  The package for which to list domains.

• MaxResults (integer) -- Limits results to a maximum number of domains.
• NextToken (string) -- Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Return type

dict

Returns

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Container for response parameters to ListDomainsForPackage operation.

  • DomainPackageDetailsList (list) --

    List of DomainPackageDetails objects.

    • (dict) --

      Information on a package that is associated with a domain.

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • LastUpdated (datetime) --

        Timestamp of the most-recent update to the association status.

      • DomainName (string) --

        Name of the domain you've associated a package with.

      • DomainPackageStatus (string) --

        State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

      • PackageVersion (string) --

      • ReferencePath (string) --

        The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

  • NextToken (string) --

Exceptions

• ElasticsearchService.Client.exceptions.BaseException
• ElasticsearchService.Client.exceptions.InternalException
• ElasticsearchService.Client.exceptions.ResourceNotFoundException
• ElasticsearchService.Client.exceptions.AccessDeniedException
• ElasticsearchService.Client.exceptions.ValidationException