ElasticsearchService / Client / update_package

update_package#

ElasticsearchService.Client.update_package(**kwargs)#

Updates a package for use with Amazon ES domains.

See also: AWS API Documentation

Request Syntax

response = client.update_package(
    PackageID='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    },
    PackageDescription='string',
    CommitMessage='string'
)
Parameters:

  • PackageID (string) –

    [REQUIRED]

    Unique identifier for the package.

  • PackageSource (dict) –

    [REQUIRED]

    The S3 location for importing the package specified as S3BucketName and S3Key

    • S3BucketName (string) –

      Name of the bucket containing the package.

    • S3Key (string) –

      Key (file name) of the package.

  • PackageDescription (string) – New description of the package.

  • CommitMessage (string) – An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

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 UpdatePackage 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