OpenSearchService / Client / update_package



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(
        'S3BucketName': 'string',
        'S3Key': 'string'
  • PackageID (string) –


    The unique identifier for the package.

  • PackageSource (dict) –


    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:



Response Syntax

    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
        'PackageDescription': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'AvailablePackageVersion': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        'EngineVersion': 'string',
        'AvailablePluginProperties': {
            'Name': 'string',
            'Description': 'string',
            'Version': 'string',
            'ClassName': 'string',
            'UncompressedSizeInBytes': 123

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.

      • EngineVersion (string) –

        Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

      • AvailablePluginProperties (dict) –

        If the package is a ZIP-PLUGIN package, additional information about plugin properties.

        • Name (string) –

          The name of the plugin.

        • Description (string) –

          The description of the plugin.

        • Version (string) –

          The version of the plugin.

        • ClassName (string) –

          The name of the class to load.

        • UncompressedSizeInBytes (integer) –

          The uncompressed size of the plugin.