AWS API Changes

2024/11/11 - Amazon OpenSearch Service - 3 new9 updated api methods

Changes Adds Support for new AssociatePackages and DissociatePackages API in Amazon OpenSearch Service that allows association and dissociation operations to be carried out on multiple packages at the same time.

AssociatePackages (new)

Link ¶

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

See also: AWS API Documentation

Request Syntax

client.associate_packages(
    PackageList=[
        {
            'PackageID': 'string',
            'PrerequisitePackageIDList': [
                'string',
            ],
            'AssociationConfiguration': {
                'KeyStoreAccessOption': {
                    'KeyAccessRoleArn': 'string',
                    'KeyStoreAccessEnabled': True|False
                }
            }
        },
    ],
    DomainName='string'
)

type PackageList:

list

param PackageList:

[REQUIRED]

A list of packages and their prerequisites to be associated with a domain.

(dict) --

Details of a package that is associated with a domain.
- PackageID (string) -- [REQUIRED]
  
  Internal ID of the package that you want to associate with a domain.
- PrerequisitePackageIDList (list) --
  
  List of package IDs that must be associated with the domain with or before the package can be associated.
  - (string) --
- AssociationConfiguration (dict) --
  
  The configuration parameters for associating the package with a domain.
  - KeyStoreAccessOption (dict) --
    
    The configuration parameters to enable accessing the key store required by the package.
    - KeyAccessRoleArn (string) --
      
      Role ARN to access the KeyStore Key
    - KeyStoreAccessEnabled (boolean) -- [REQUIRED]
      
      This indicates whether Key Store access is enabled

type DomainName:

string

param DomainName:

[REQUIRED]

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'PrerequisitePackageIDList': [
                'string',
            ],
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            },
            'AssociationConfiguration': {
                'KeyStoreAccessOption': {
                    'KeyAccessRoleArn': 'string',
                    'KeyStoreAccessEnabled': True|False
                }
            }
        },
    ]
}

Response Structure

(dict) --
- DomainPackageDetailsList (list) --
  
  List of information about packages that are associated with a domain.
  - (dict) --
    
    Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
    - PackageID (string) --
      
      Internal ID of the package.
    - PackageName (string) --
      
      User-specified name of the package.
    - PackageType (string) --
      
      The type of package.
    - LastUpdated (datetime) --
      
      Timestamp of the most recent update to the package association status.
    - DomainName (string) --
      
      Name of the domain that the package is associated with.
    - DomainPackageStatus (string) --
      
      State of the association.
    - PackageVersion (string) --
      
      The current version of the package.
    - PrerequisitePackageIDList (list) --
      
      A list of package IDs that must be associated with the domain before or with the package can be associated.
      - (string) --
    - ReferencePath (string) --
      
      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
    - 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.
    - AssociationConfiguration (dict) --
      
      The configuration for associating a package with an Amazon OpenSearch Service domain.
      - KeyStoreAccessOption (dict) --
        
        The configuration parameters to enable accessing the key store required by the package.
        
        KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
        
        KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled

UpdatePackageScope (new)

Link ¶

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

See also: AWS API Documentation

Request Syntax

client.update_package_scope(
    PackageID='string',
    Operation='ADD'|'OVERRIDE'|'REMOVE',
    PackageUserList=[
        'string',
    ]
)

type PackageID:

string

param PackageID:

[REQUIRED]

ID of the package whose scope is being updated.

type Operation:

string

param Operation:

[REQUIRED]

The operation to perform on the package scope (e.g., add/remove/override users).

type PackageUserList:

list

param PackageUserList:

[REQUIRED]

List of users to be added or removed from the package scope.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'PackageID': 'string',
    'Operation': 'ADD'|'OVERRIDE'|'REMOVE',
    'PackageUserList': [
        'string',
    ]
}

Response Structure

(dict) --
- PackageID (string) --
  
  ID of the package whose scope was updated.
- Operation (string) --
  
  The operation that was performed on the package scope.
- PackageUserList (list) --
  
  List of users who have access to the package after the scope update.
  - (string) --

DissociatePackages (new)

Link ¶

Dissociates multiple packages from a domain simulatneously.

See also: AWS API Documentation

Request Syntax

client.dissociate_packages(
    PackageList=[
        'string',
    ],
    DomainName='string'
)

type PackageList:

list

param PackageList:

[REQUIRED]

A list of package IDs to be dissociated from a domain.

(string) --

type DomainName:

string

param DomainName:

[REQUIRED]

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'PrerequisitePackageIDList': [
                'string',
            ],
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            },
            'AssociationConfiguration': {
                'KeyStoreAccessOption': {
                    'KeyAccessRoleArn': 'string',
                    'KeyStoreAccessEnabled': True|False
                }
            }
        },
    ]
}

Response Structure

(dict) --
- DomainPackageDetailsList (list) --
  
  A list of package details for the packages that were dissociated from the domain.
  - (dict) --
    
    Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
    - PackageID (string) --
      
      Internal ID of the package.
    - PackageName (string) --
      
      User-specified name of the package.
    - PackageType (string) --
      
      The type of package.
    - LastUpdated (datetime) --
      
      Timestamp of the most recent update to the package association status.
    - DomainName (string) --
      
      Name of the domain that the package is associated with.
    - DomainPackageStatus (string) --
      
      State of the association.
    - PackageVersion (string) --
      
      The current version of the package.
    - PrerequisitePackageIDList (list) --
      
      A list of package IDs that must be associated with the domain before or with the package can be associated.
      - (string) --
    - ReferencePath (string) --
      
      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
    - 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.
    - AssociationConfiguration (dict) --
      
      The configuration for associating a package with an Amazon OpenSearch Service domain.
      - KeyStoreAccessOption (dict) --
        
        The configuration parameters to enable accessing the key store required by the package.
        
        KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
        
        KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled

AssociatePackage (updated)

Link ¶
Changes (request, response)
Request

{'AssociationConfiguration': {'KeyStoreAccessOption': {'KeyAccessRoleArn': 'string',
                                                       'KeyStoreAccessEnabled': 'boolean'}},
 'PrerequisitePackageIDList': ['string']}

Response

{'DomainPackageDetails': {'AssociationConfiguration': {'KeyStoreAccessOption': {'KeyAccessRoleArn': 'string',
                                                                                'KeyStoreAccessEnabled': 'boolean'}},
                          'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                          'PrerequisitePackageIDList': ['string']}}

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.associate_package(
    PackageID='string',
    DomainName='string',
    PrerequisitePackageIDList=[
        'string',
    ],
    AssociationConfiguration={
        'KeyStoreAccessOption': {
            'KeyAccessRoleArn': 'string',
            'KeyStoreAccessEnabled': True|False
        }
    }
)

type PackageID:

string

param PackageID:

[REQUIRED]

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

type DomainName:

string

param DomainName:

[REQUIRED]

Name of the domain to associate the package with.

type PrerequisitePackageIDList:

list

param PrerequisitePackageIDList:

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

(string) --

type AssociationConfiguration:

dict

param AssociationConfiguration:

The configuration for associating a package with an Amazon OpenSearch Service domain.

KeyStoreAccessOption (dict) --

The configuration parameters to enable accessing the key store required by the package.
- KeyAccessRoleArn (string) --
  
  Role ARN to access the KeyStore Key
- KeyStoreAccessEnabled (boolean) -- [REQUIRED]
  
  This indicates whether Key Store access is enabled

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'PrerequisitePackageIDList': [
            'string',
        ],
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        },
        'AssociationConfiguration': {
            'KeyStoreAccessOption': {
                'KeyAccessRoleArn': 'string',
                'KeyStoreAccessEnabled': True|False
            }
        }
    }
}

Response Structure

(dict) --

Container for the response returned by the AssociatePackage operation.
- DomainPackageDetails (dict) --
  
  Information about a package that is associated with a domain.
  - PackageID (string) --
    
    Internal ID of the package.
  - PackageName (string) --
    
    User-specified name of the package.
  - PackageType (string) --
    
    The type of package.
  - LastUpdated (datetime) --
    
    Timestamp of the most recent update to the package association status.
  - DomainName (string) --
    
    Name of the domain that the package is associated with.
  - DomainPackageStatus (string) --
    
    State of the association.
  - PackageVersion (string) --
    
    The current version of the package.
  - PrerequisitePackageIDList (list) --
    
    A list of package IDs that must be associated with the domain before or with the package can be associated.
    - (string) --
  - ReferencePath (string) --
    
    The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
  - 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.
  - AssociationConfiguration (dict) --
    
    The configuration for associating a package with an Amazon OpenSearch Service domain.
    - KeyStoreAccessOption (dict) --
      
      The configuration parameters to enable accessing the key store required by the package.
      - KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
      - KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled

CreatePackage (updated)

Link ¶
Changes (request, response)
Request

{'EngineVersion': 'string',
 'PackageConfiguration': {'ConfigurationRequirement': 'REQUIRED | OPTIONAL | '
                                                      'NONE',
                          'LicenseFilepath': 'string',
                          'LicenseRequirement': 'REQUIRED | OPTIONAL | NONE',
                          'RequiresRestartForConfigurationUpdate': 'boolean'},
 'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                              'KmsKeyIdentifier': 'string'},
 'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
 'PackageVendingOptions': {'VendingEnabled': 'boolean'}}

Response

{'PackageDetails': {'AllowListedUserList': ['string'],
                    'AvailablePackageConfiguration': {'ConfigurationRequirement': 'REQUIRED '
                                                                                  '| '
                                                                                  'OPTIONAL '
                                                                                  '| '
                                                                                  'NONE',
                                                      'LicenseFilepath': 'string',
                                                      'LicenseRequirement': 'REQUIRED '
                                                                            '| '
                                                                            'OPTIONAL '
                                                                            '| '
                                                                            'NONE',
                                                      'RequiresRestartForConfigurationUpdate': 'boolean'},
                    'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                                                 'KmsKeyIdentifier': 'string'},
                    'PackageOwner': 'string',
                    'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                    'PackageVendingOptions': {'VendingEnabled': 'boolean'}}}

Creates 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

client.create_package(
    PackageName='string',
    PackageType='TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
    PackageDescription='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    },
    PackageConfiguration={
        'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
        'LicenseFilepath': 'string',
        'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
        'RequiresRestartForConfigurationUpdate': True|False
    },
    EngineVersion='string',
    PackageVendingOptions={
        'VendingEnabled': True|False
    },
    PackageEncryptionOptions={
        'KmsKeyIdentifier': 'string',
        'EncryptionEnabled': True|False
    }
)

type PackageName:

string

param PackageName:

[REQUIRED]

Unique name for the package.

type PackageType:

string

param PackageType:

[REQUIRED]

The type of package.

type PackageDescription:

string

param PackageDescription:

Description of the package.

type PackageSource:

dict

param PackageSource:

[REQUIRED]

The Amazon S3 location from which to import the package.

S3BucketName (string) --

The name of the Amazon S3 bucket containing the package.
S3Key (string) --

Key (file name) of the package.

type PackageConfiguration:

dict

param PackageConfiguration:

The configuration parameters for the package being created.

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.

type EngineVersion:

string

param EngineVersion:

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

type PackageVendingOptions:

dict

param PackageVendingOptions:

The vending options for the package being created. They determine if the package can be vended to other users.

VendingEnabled (boolean) -- [REQUIRED]

This indicates whether vending is enabled for the package to determine if package can be used by other users.

type PackageEncryptionOptions:

dict

param PackageEncryptionOptions:

The encryption parameters for the package being created.

KmsKeyIdentifier (string) --

KMS key ID for encrypting the package.
EncryptionEnabled (boolean) -- [REQUIRED]

This indicates whether encryption is enabled for the package.

rtype:

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 CreatePackage operation.
- PackageDetails (dict) --
  
  Basic information about an OpenSearch Service 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/update a package and add users to the package scope.
  - PackageVendingOptions (dict) --
    
    Package Vending Options for a package.
    - VendingEnabled (boolean) --
      
      This indicates whether vending is enabled for the package to determine if package can be used by other users.
  - PackageEncryptionOptions (dict) --
    
    Package Encryption Options for a package.
    - KmsKeyIdentifier (string) --
      
      KMS key ID for encrypting the package.
    - EncryptionEnabled (boolean) --
      
      This indicates whether encryption is enabled for the package.

DeletePackage (updated)

Link ¶
Changes (response)

{'PackageDetails': {'AllowListedUserList': ['string'],
                    'AvailablePackageConfiguration': {'ConfigurationRequirement': 'REQUIRED '
                                                                                  '| '
                                                                                  'OPTIONAL '
                                                                                  '| '
                                                                                  'NONE',
                                                      'LicenseFilepath': 'string',
                                                      'LicenseRequirement': 'REQUIRED '
                                                                            '| '
                                                                            'OPTIONAL '
                                                                            '| '
                                                                            'NONE',
                                                      'RequiresRestartForConfigurationUpdate': 'boolean'},
                    'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                                                 'KmsKeyIdentifier': 'string'},
                    'PackageOwner': 'string',
                    'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                    'PackageVendingOptions': {'VendingEnabled': 'boolean'}}}

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.delete_package(
    PackageID='string'
)

type PackageID:

string

param PackageID:

[REQUIRED]

The internal ID of the package you want to delete. Use DescribePackages to find this value.

rtype:

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 parameters to the DeletePackage operation.
- PackageDetails (dict) --
  
  Information about the deleted 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/update a package and add users to the package scope.
  - PackageVendingOptions (dict) --
    
    Package Vending Options for a package.
    - VendingEnabled (boolean) --
      
      This indicates whether vending is enabled for the package to determine if package can be used by other users.
  - PackageEncryptionOptions (dict) --
    
    Package Encryption Options for a package.
    - KmsKeyIdentifier (string) --
      
      KMS key ID for encrypting the package.
    - EncryptionEnabled (boolean) --
      
      This indicates whether encryption is enabled for the package.

DescribePackages (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'Name': {'PackageOwner'}}}

Response

{'PackageDetailsList': {'AllowListedUserList': ['string'],
                        'AvailablePackageConfiguration': {'ConfigurationRequirement': 'REQUIRED '
                                                                                      '| '
                                                                                      'OPTIONAL '
                                                                                      '| '
                                                                                      'NONE',
                                                          'LicenseFilepath': 'string',
                                                          'LicenseRequirement': 'REQUIRED '
                                                                                '| '
                                                                                'OPTIONAL '
                                                                                '| '
                                                                                'NONE',
                                                          'RequiresRestartForConfigurationUpdate': 'boolean'},
                        'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                                                     'KmsKeyIdentifier': 'string'},
                        'PackageOwner': 'string',
                        'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                        'PackageVendingOptions': {'VendingEnabled': 'boolean'}}}

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.describe_packages(
    Filters=[
        {
            'Name': 'PackageID'|'PackageName'|'PackageStatus'|'PackageType'|'EngineVersion'|'PackageOwner',
            'Value': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters:

list

param Filters:

Only returns packages that match the DescribePackagesFilterList values.

(dict) --

A filter to apply to the DescribePackage response.
- Name (string) --
  
  Any field from PackageDetails.
- Value (list) --
  
  A non-empty list of values for the specified filter field.
  - (string) --

type MaxResults:

integer

param MaxResults:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

type NextToken:

string

param NextToken:

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

rtype:

dict

returns:

Response Syntax

{
    'PackageDetailsList': [
        {
            '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
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Container for the response returned by the DescribePackages operation.
- PackageDetailsList (list) --
  
  Basic information about a package.
  - (dict) --
    
    Basic 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/update a package and add users to the package scope.
    - PackageVendingOptions (dict) --
      
      Package Vending Options for a package.
      - VendingEnabled (boolean) --
        
        This indicates whether vending is enabled for the package to determine if package can be used by other users.
    - PackageEncryptionOptions (dict) --
      
      Package Encryption Options for a package.
      - KmsKeyIdentifier (string) --
        
        KMS key ID for encrypting the package.
      - EncryptionEnabled (boolean) --
        
        This indicates whether encryption is enabled for the package.
- NextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

DissociatePackage (updated)

Link ¶
Changes (response)

{'DomainPackageDetails': {'AssociationConfiguration': {'KeyStoreAccessOption': {'KeyAccessRoleArn': 'string',
                                                                                'KeyStoreAccessEnabled': 'boolean'}},
                          'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                          'PrerequisitePackageIDList': ['string']}}

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.dissociate_package(
    PackageID='string',
    DomainName='string'
)

type PackageID:

string

param PackageID:

[REQUIRED]

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

type DomainName:

string

param DomainName:

[REQUIRED]

Name of the domain to dissociate the package from.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'PrerequisitePackageIDList': [
            'string',
        ],
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        },
        'AssociationConfiguration': {
            'KeyStoreAccessOption': {
                'KeyAccessRoleArn': 'string',
                'KeyStoreAccessEnabled': True|False
            }
        }
    }
}

Response Structure

(dict) --

Container for the response returned by an DissociatePackage operation.
- DomainPackageDetails (dict) --
  
  Information about a package that has been dissociated from the domain.
  - PackageID (string) --
    
    Internal ID of the package.
  - PackageName (string) --
    
    User-specified name of the package.
  - PackageType (string) --
    
    The type of package.
  - LastUpdated (datetime) --
    
    Timestamp of the most recent update to the package association status.
  - DomainName (string) --
    
    Name of the domain that the package is associated with.
  - DomainPackageStatus (string) --
    
    State of the association.
  - PackageVersion (string) --
    
    The current version of the package.
  - PrerequisitePackageIDList (list) --
    
    A list of package IDs that must be associated with the domain before or with the package can be associated.
    - (string) --
  - ReferencePath (string) --
    
    The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
  - 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.
  - AssociationConfiguration (dict) --
    
    The configuration for associating a package with an Amazon OpenSearch Service domain.
    - KeyStoreAccessOption (dict) --
      
      The configuration parameters to enable accessing the key store required by the package.
      - KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
      - KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled

GetPackageVersionHistory (updated)

Link ¶
Changes (response)

{'PackageVersionHistoryList': {'PackageConfiguration': {'ConfigurationRequirement': 'REQUIRED '
                                                                                    '| '
                                                                                    'OPTIONAL '
                                                                                    '| '
                                                                                    'NONE',
                                                        'LicenseFilepath': 'string',
                                                        'LicenseRequirement': 'REQUIRED '
                                                                              '| '
                                                                              'OPTIONAL '
                                                                              '| '
                                                                              'NONE',
                                                        'RequiresRestartForConfigurationUpdate': 'boolean'}}}

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.get_package_version_history(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)

type PackageID:

string

param PackageID:

[REQUIRED]

The unique identifier of the package.

type MaxResults:

integer

param MaxResults:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

type NextToken:

string

param NextToken:

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

rtype:

dict

returns:

Response Syntax

{
    'PackageID': 'string',
    'PackageVersionHistoryList': [
        {
            'PackageVersion': 'string',
            'CommitMessage': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'PluginProperties': {
                'Name': 'string',
                'Description': 'string',
                'Version': 'string',
                'ClassName': 'string',
                'UncompressedSizeInBytes': 123
            },
            'PackageConfiguration': {
                'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
                'LicenseFilepath': 'string',
                'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
                'RequiresRestartForConfigurationUpdate': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Container for response returned by GetPackageVersionHistory operation.
- PackageID (string) --
  
  The unique identifier of the package.
- PackageVersionHistoryList (list) --
  
  A list of package versions, along with their creation time and commit message.
  - (dict) --
    
    Details about a package version.
    - PackageVersion (string) --
      
      The package version.
    - CommitMessage (string) --
      
      A message associated with the package version when it was uploaded.
    - CreatedAt (datetime) --
      
      The date and time when the package was created.
    - PluginProperties (dict) --
      
      Additional information about plugin properties if the package is a ZIP-PLUGIN package.
      - 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.
    - PackageConfiguration (dict) --
      
      The configuration details for a specific version of a 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.
- NextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

ListDomainsForPackage (updated)

Link ¶
Changes (response)

{'DomainPackageDetailsList': {'AssociationConfiguration': {'KeyStoreAccessOption': {'KeyAccessRoleArn': 'string',
                                                                                    'KeyStoreAccessEnabled': 'boolean'}},
                              'PackageType': {'PACKAGE-CONFIG',
                                              'PACKAGE-LICENSE'},
                              'PrerequisitePackageIDList': ['string']}}

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.list_domains_for_package(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)

type PackageID:

string

param PackageID:

[REQUIRED]

The unique identifier of the package for which to list associated domains.

type MaxResults:

integer

param MaxResults:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

type NextToken:

string

param NextToken:

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'PrerequisitePackageIDList': [
                'string',
            ],
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            },
            'AssociationConfiguration': {
                'KeyStoreAccessOption': {
                    'KeyAccessRoleArn': 'string',
                    'KeyStoreAccessEnabled': True|False
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Container for the response parameters to the ListDomainsForPackage operation.
- DomainPackageDetailsList (list) --
  
  Information about all domains associated with a package.
  - (dict) --
    
    Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
    - PackageID (string) --
      
      Internal ID of the package.
    - PackageName (string) --
      
      User-specified name of the package.
    - PackageType (string) --
      
      The type of package.
    - LastUpdated (datetime) --
      
      Timestamp of the most recent update to the package association status.
    - DomainName (string) --
      
      Name of the domain that the package is associated with.
    - DomainPackageStatus (string) --
      
      State of the association.
    - PackageVersion (string) --
      
      The current version of the package.
    - PrerequisitePackageIDList (list) --
      
      A list of package IDs that must be associated with the domain before or with the package can be associated.
      - (string) --
    - ReferencePath (string) --
      
      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
    - 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.
    - AssociationConfiguration (dict) --
      
      The configuration for associating a package with an Amazon OpenSearch Service domain.
      - KeyStoreAccessOption (dict) --
        
        The configuration parameters to enable accessing the key store required by the package.
        
        KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
        
        KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled
- NextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

ListPackagesForDomain (updated)

Link ¶
Changes (response)

{'DomainPackageDetailsList': {'AssociationConfiguration': {'KeyStoreAccessOption': {'KeyAccessRoleArn': 'string',
                                                                                    'KeyStoreAccessEnabled': 'boolean'}},
                              'PackageType': {'PACKAGE-CONFIG',
                                              'PACKAGE-LICENSE'},
                              'PrerequisitePackageIDList': ['string']}}

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

client.list_packages_for_domain(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

type DomainName:

string

param DomainName:

[REQUIRED]

The name of the domain for which you want to list associated packages.

type MaxResults:

integer

param MaxResults:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

type NextToken:

string

param NextToken:

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'PrerequisitePackageIDList': [
                'string',
            ],
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            },
            'AssociationConfiguration': {
                'KeyStoreAccessOption': {
                    'KeyAccessRoleArn': 'string',
                    'KeyStoreAccessEnabled': True|False
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Container for the response parameters to the ListPackagesForDomain operation.
- DomainPackageDetailsList (list) --
  
  List of all packages associated with a domain.
  - (dict) --
    
    Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
    - PackageID (string) --
      
      Internal ID of the package.
    - PackageName (string) --
      
      User-specified name of the package.
    - PackageType (string) --
      
      The type of package.
    - LastUpdated (datetime) --
      
      Timestamp of the most recent update to the package association status.
    - DomainName (string) --
      
      Name of the domain that the package is associated with.
    - DomainPackageStatus (string) --
      
      State of the association.
    - PackageVersion (string) --
      
      The current version of the package.
    - PrerequisitePackageIDList (list) --
      
      A list of package IDs that must be associated with the domain before or with the package can be associated.
      - (string) --
    - ReferencePath (string) --
      
      The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
    - 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.
    - AssociationConfiguration (dict) --
      
      The configuration for associating a package with an Amazon OpenSearch Service domain.
      - KeyStoreAccessOption (dict) --
        
        The configuration parameters to enable accessing the key store required by the package.
        
        KeyAccessRoleArn (string) --
        
        Role ARN to access the KeyStore Key
        
        KeyStoreAccessEnabled (boolean) --
        
        This indicates whether Key Store access is enabled
- NextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

UpdatePackage (updated)

Link ¶
Changes (request, response)
Request

{'PackageConfiguration': {'ConfigurationRequirement': 'REQUIRED | OPTIONAL | '
                                                      'NONE',
                          'LicenseFilepath': 'string',
                          'LicenseRequirement': 'REQUIRED | OPTIONAL | NONE',
                          'RequiresRestartForConfigurationUpdate': 'boolean'},
 'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                              'KmsKeyIdentifier': 'string'}}

Response

{'PackageDetails': {'AllowListedUserList': ['string'],
                    'AvailablePackageConfiguration': {'ConfigurationRequirement': 'REQUIRED '
                                                                                  '| '
                                                                                  'OPTIONAL '
                                                                                  '| '
                                                                                  'NONE',
                                                      'LicenseFilepath': 'string',
                                                      'LicenseRequirement': 'REQUIRED '
                                                                            '| '
                                                                            'OPTIONAL '
                                                                            '| '
                                                                            'NONE',
                                                      'RequiresRestartForConfigurationUpdate': 'boolean'},
                    'PackageEncryptionOptions': {'EncryptionEnabled': 'boolean',
                                                 'KmsKeyIdentifier': 'string'},
                    'PackageOwner': 'string',
                    'PackageType': {'PACKAGE-LICENSE', 'PACKAGE-CONFIG'},
                    'PackageVendingOptions': {'VendingEnabled': 'boolean'}}}

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

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
    }
)

type PackageID:

string

param PackageID:

[REQUIRED]

The unique identifier for the package.

type PackageSource:

dict

param PackageSource:

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

type PackageDescription:

string

param PackageDescription:

A new description of the package.

type CommitMessage:

string

param CommitMessage:

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

type PackageConfiguration:

dict

param PackageConfiguration:

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.

type PackageEncryptionOptions:

dict

param PackageEncryptionOptions:

Encryption options for a package.

KmsKeyIdentifier (string) --

KMS key ID for encrypting the package.
EncryptionEnabled (boolean) -- [REQUIRED]

This indicates whether encryption is enabled for the package.

rtype:

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/update a package and add users to the package scope.
  - PackageVendingOptions (dict) --
    
    Package Vending Options for a package.
    - VendingEnabled (boolean) --
      
      This indicates whether vending is enabled for the package to determine if package can be used by other users.
  - PackageEncryptionOptions (dict) --
    
    Package Encryption Options for a package.
    - KmsKeyIdentifier (string) --
      
      KMS key ID for encrypting the package.
    - EncryptionEnabled (boolean) --
      
      This indicates whether encryption is enabled for the package.