POST

/2015-01-01/packages/describe

http://es.{region}.amazonaws.com/2015-01-01/packages/describe

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

Access Token Required: API Key

Query Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersarray

A list of <code>DescribePackagesFilter</code> to filter the packages included in a <code>DescribePackages</code> response.

NextTokenstring

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.

MaxResultsinteger

Set this value to limit the number of results returned.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://es.{region}.amazonaws.com/2015-01-01/packages/describe' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}