/2015-01-01/packages/describe - Amazon Elasticsearch Service

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/packages/describe' \ --header 'Content-Type: application/json' \ --data-raw '{ "Filters": [ { "Name": "PackageID", "Value": [] } ], "MaxResults": 100, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Body Params application/json

Filters

array[object (DescribePackagesFilter) {2}]

optional

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

Name

enum<string>

optional

Any field from PackageDetails.

Allowed values:

PackageIDPackageNamePackageStatus

Value

array[string]

optional

A list of values for the specified field.

MaxResults

integer

optional

Set this value to limit the number of results returned.

<= 100

NextToken

string

optional

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Examples

Responses

🟢200Success

application/json

Body

Container for response returned by <code> <a>DescribePackages</a> </code> operation.

PackageDetailsList

array[object (PackageDetails) {9}]

optional

List of PackageDetails objects.

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.

NextToken

string

optional

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483AccessDeniedException

🟠484ValidationException