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',
    PackageConfiguration={
        'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
        'LicenseFilepath': 'string',
        'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
        'RequiresRestartForConfigurationUpdate': True|False
    },
    PackageEncryptionOptions={
        'KmsKeyIdentifier': 'string',
        'EncryptionEnabled': True|False
    }
)

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.

• PackageConfiguration (dict) –

  The updated configuration details for a package.

  • LicenseRequirement (string) – [REQUIRED]

    The license requirements for the package.

  • LicenseFilepath (string) –

    The relative file path for the license associated with the package.

  • ConfigurationRequirement (string) – [REQUIRED]

    The configuration requirements for the package.

  • RequiresRestartForConfigurationUpdate (boolean) –

    This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

• PackageEncryptionOptions (dict) –

  Encryption options for a package.

  • KmsKeyIdentifier (string) –

    KMS key ID for encrypting the package.

  • EncryptionEnabled (boolean) – [REQUIRED]

    Whether encryption is enabled for the package.

Return type:

dict

Returns:

Response Syntax

{
    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
        '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'
        },
        'EngineVersion': 'string',
        'AvailablePluginProperties': {
            'Name': 'string',
            'Description': 'string',
            'Version': 'string',
            'ClassName': 'string',
            'UncompressedSizeInBytes': 123
        },
        'AvailablePackageConfiguration': {
            'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
            'LicenseFilepath': 'string',
            'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
            'RequiresRestartForConfigurationUpdate': True|False
        },
        'AllowListedUserList': [
            'string',
        ],
        'PackageOwner': 'string',
        'PackageVendingOptions': {
            'VendingEnabled': True|False
        },
        'PackageEncryptionOptions': {
            'KmsKeyIdentifier': 'string',
            'EncryptionEnabled': True|False
        }
    }
}

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.

    • AvailablePackageConfiguration (dict) –

      This represents the available configuration parameters for the package.

      • LicenseRequirement (string) –

        The license requirements for the package.

      • LicenseFilepath (string) –

        The relative file path for the license associated with the package.

      • ConfigurationRequirement (string) –

        The configuration requirements for the package.

      • RequiresRestartForConfigurationUpdate (boolean) –

        This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

    • AllowListedUserList (list) –

      A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

      • (string) –

    • PackageOwner (string) –

      The owner of the package who is allowed to create and update a package and add users to the package scope.

    • PackageVendingOptions (dict) –

      Package Vending Options for a package.

      • VendingEnabled (boolean) –

        Indicates whether the package vending feature is enabled, allowing the package to be used by other users.

    • PackageEncryptionOptions (dict) –

      Encryption options for a package.

      • KmsKeyIdentifier (string) –

        KMS key ID for encrypting the package.

      • EncryptionEnabled (boolean) –

        Whether encryption is enabled for the package.

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