OpenSearchService / Client / update_package

update_package

OpenSearchService.Client.update_package(**kwargs)

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

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]

  The unique identifier for the package.

• PackageSource (dict) –

  [REQUIRED]

  Amazon S3 bucket and key for the package.

  • S3BucketName (string) –

    The name of the Amazon S3 bucket containing the package.

  • S3Key (string) –

    Key (file name) of the package.

• PackageDescription (string) – A new description of the package.

• CommitMessage (string) – Commit message for the updated file, which is 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 the response returned by the UpdatePackage operation.

  • PackageDetails (dict) –

    Information about a package.

    • PackageID (string) –

      The unique identifier of the package.

    • PackageName (string) –

      The user-specified name of the package.

    • PackageType (string) –

      The type of package.

    • PackageDescription (string) –

      User-specified description of the package.

    • PackageStatus (string) –

      The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

    • CreatedAt (datetime) –

      The timestamp when the package was created.

    • LastUpdatedAt (datetime) –

      Date and time when the package was last updated.

    • AvailablePackageVersion (string) –

      The package version.

    • 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.

Exceptions

• OpenSearchService.Client.exceptions.BaseException

• OpenSearchService.Client.exceptions.InternalException

• OpenSearchService.Client.exceptions.LimitExceededException

• OpenSearchService.Client.exceptions.ResourceNotFoundException

• OpenSearchService.Client.exceptions.AccessDeniedException

• OpenSearchService.Client.exceptions.ValidationException