Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.associate_package(
  • PackageID (string) --


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

  • DomainName (string) --


    Name of the domain to associate the package with.

Return type



Response Syntax

    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'PackageVersion': 'string',
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'

Response Structure

  • (dict) --

    Container for the response returned by the AssociatePackage operation.

    • DomainPackageDetails (dict) --

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

        The type of package.

      • LastUpdated (datetime) --

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

      • DomainName (string) --

        Name of the domain that the package is associated with.

      • DomainPackageStatus (string) --

        State of the association.

      • PackageVersion (string) --

        The current version of the package.

      • ReferencePath (string) --

        Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

      • ErrorDetails (dict) --

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

        • ErrorType (string) --

          The type of error that occurred.

        • ErrorMessage (string) --

          A message describing the error.


  • OpenSearchService.Client.exceptions.BaseException
  • OpenSearchService.Client.exceptions.InternalException
  • OpenSearchService.Client.exceptions.ResourceNotFoundException
  • OpenSearchService.Client.exceptions.AccessDeniedException
  • OpenSearchService.Client.exceptions.ValidationException
  • OpenSearchService.Client.exceptions.ConflictException