/2015-01-01/packages/{PackageID}

The Amazon Elasticsearch Service multi-region endpoint

DELETE

Delete the package.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'http://es.{region}.amazonaws.com/2015-01-01/packages/'

Response Example

200 - Example 1

{
  "PackageDetails": {
    "PackageID": "string",
    "PackageName": "string",
    "PackageType": "TXT-DICTIONARY",
    "PackageDescription": "string",
    "PackageStatus": "COPYING",
    "CreatedAt": "string",
    "LastUpdatedAt": "2019-08-24T14:15:22Z",
    "AvailablePackageVersion": "string",
    "ErrorDetails": {
      "ErrorType": "string",
      "ErrorMessage": "string"
    }
  }
}

Request

Path Params

PackageID

string

required

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

Responses

🟢200Success

application/json

Body

Container for response parameters to <code> <a>DeletePackage</a> </code> operation.

PackageDetails

object

optional

PackageDetails

PackageID

string

optional

Internal ID of the package.

PackageName

string

optional

User specified name of the package.

>= 3 characters<= 28 characters

Match pattern:

[a-z][a-z0-9\-]+

PackageType

enum<string>

optional

Currently supports only TXT-DICTIONARY.

Allowed value:

TXT-DICTIONARY

PackageDescription

string

optional

User-specified description of the package.

<= 1024 characters

PackageStatus

enum<string>

optional

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

Allowed values:

COPYINGCOPY_FAILEDVALIDATINGVALIDATION_FAILEDAVAILABLEDELETINGDELETEDDELETE_FAILED

CreatedAt

string <date-time>

optional

Timestamp which tells creation date of the package.

LastUpdatedAt

string <date-time>

LastUpdated

optional

AvailablePackageVersion

string

PackageVersion

optional

ErrorDetails

object

optional

Additional information if the package is in an error state. Null otherwise.

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483AccessDeniedException

🟠484ValidationException

🟠485ConflictException

Modified at 2023-08-15 04:15:53

/2015-01-01/es/ccs/outboundConnection/{ConnectionId}

/2015-01-01/es/vpcEndpoints/{VpcEndpointId}