ElasticsearchService / Client / list_packages_for_domain

list_packages_for_domain#

ElasticsearchService.Client.list_packages_for_domain(**kwargs)#

Lists all packages associated with the Amazon ES domain.

See also: AWS API Documentation

Request Syntax

response = client.list_packages_for_domain(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain for which you want to list associated packages.

  • MaxResults (integer) – Limits results to a maximum number of packages.

  • 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 ListPackagesForDomain 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) –

      Pagination token that needs to be supplied to the next call to get the next page of results.

Exceptions