OpenSearchService / Client / delete_package

delete_package#

OpenSearchService.Client.delete_package(**kwargs)#

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

Request Syntax

response = client.delete_package(
    PackageID='string'
)

Parameters:

PackageID (string) –

[REQUIRED]

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

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

delete_package#

Request Syntax

Response Syntax

Response Structure

Exceptions