ElasticsearchService / Client / delete_package

delete_package#

ElasticsearchService.Client.delete_package(**kwargs)#

Delete the package.

Request Syntax

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

Parameters:

PackageID (string) –

[REQUIRED]

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

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 response parameters to ``DeletePackage ``operation.
- PackageDetails (dict) –
  
  PackageDetails
  - PackageID (string) –
    
    Internal ID of the package.
  - PackageName (string) –
    
    User specified name of the package.
  - PackageType (string) –
    
    Currently supports only TXT-DICTIONARY.
  - PackageDescription (string) –
    
    User-specified description of the package.
  - PackageStatus (string) –
    
    Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
  - CreatedAt (datetime) –
    
    Timestamp which tells creation date of the package.
  - LastUpdatedAt (datetime) –
  - AvailablePackageVersion (string) –
  - ErrorDetails (dict) –
    
    Additional information if the package is in an error state. Null otherwise.
    - ErrorType (string) –
    - ErrorMessage (string) –

Exceptions

ElasticsearchService.Client.exceptions.BaseException
ElasticsearchService.Client.exceptions.InternalException
ElasticsearchService.Client.exceptions.ResourceNotFoundException
ElasticsearchService.Client.exceptions.AccessDeniedException
ElasticsearchService.Client.exceptions.ValidationException
ElasticsearchService.Client.exceptions.ConflictException