ElasticsearchService / Client / associate_package

associate_package#

ElasticsearchService.Client.associate_package(**kwargs)#

Associates a package with an Amazon ES domain.

See also: AWS API Documentation

Request Syntax

response = client.associate_package(
    PackageID='string',
    DomainName='string'
)
Parameters:

  • PackageID (string) –

    [REQUIRED]

    Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

  • DomainName (string) –

    [REQUIRED]

    Name of the domain that you want to associate the package with.

Return type:

dict

Returns:

Response Syntax

{
    'DomainPackageDetails': {
        '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'
        }
    }
}

Response Structure

  • (dict) –

    Container for response returned by AssociatePackage operation.

    • DomainPackageDetails (dict) –

      DomainPackageDetails

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

Exceptions