create_package

ElasticsearchService.Client.create_package(**kwargs)

Create a package for use with Amazon ES domains.

See also: AWS API Documentation

Request Syntax

response = client.create_package(
    PackageName='string',
    PackageType='TXT-DICTIONARY',
    PackageDescription='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    }
)
Parameters
  • PackageName (string) --

    [REQUIRED]

    Unique identifier for the package.

  • PackageType (string) --

    [REQUIRED]

    Type of package. Currently supports only TXT-DICTIONARY.

  • PackageDescription (string) -- Description of the package.
  • PackageSource (dict) --

    [REQUIRED]

    The customer S3 location PackageSource for importing the package.

    • S3BucketName (string) --

      Name of the bucket containing the package.

    • S3Key (string) --

      Key (file name) of the package.

Return type

dict

Returns

Response Syntax

{
    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'PackageDescription': 'string',
        'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'AvailablePackageVersion': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for response returned by CreatePackage operation.

    • PackageDetails (dict) --

      Information about the package PackageDetails .

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • PackageDescription (string) --

        User-specified description of the package.

      • PackageStatus (string) --

        Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

      • CreatedAt (datetime) --

        Timestamp which tells creation date of the package.

      • LastUpdatedAt (datetime) --

      • AvailablePackageVersion (string) --

      • ErrorDetails (dict) --

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

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

Exceptions

  • ElasticsearchService.Client.exceptions.BaseException
  • ElasticsearchService.Client.exceptions.InternalException
  • ElasticsearchService.Client.exceptions.LimitExceededException
  • ElasticsearchService.Client.exceptions.InvalidTypeException
  • ElasticsearchService.Client.exceptions.ResourceAlreadyExistsException
  • ElasticsearchService.Client.exceptions.AccessDeniedException
  • ElasticsearchService.Client.exceptions.ValidationException