---
title: "POST /2015-01-01/packages/describe"
method: POST
path: "/2015-01-01/packages/describe"
---

# POST /2015-01-01/packages/describe

`POST /2015-01-01/packages/describe`

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

## Query parameters

- `MaxResults` string
- `NextToken` string

## Request body

- object
  - `Filters` DescribePackagesFilter[] — A list of <code>DescribePackagesFilter</code> to filter the packages included in a <code>DescribePackages</code> response.
    - `Name` 'PackageID' | 'PackageName' | 'PackageStatus' — Any field from <code>PackageDetails</code>.
    - `Value` DescribePackagesFilterValue[] — A list of values for the specified field.
  - `MaxResults` integer — Set this value to limit the number of results returned.
  - `NextToken` string — 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.

## Response `200`

Success

- DescribePackagesResponse — Container for response returned by <code> <a>DescribePackages</a> </code> operation.
  - `PackageDetailsList` PackageDetails[] — List of <code>PackageDetails</code> objects.
    - `PackageID` string — Internal ID of the package.
    - `PackageName` string — User specified name of the package.
    - `PackageType` 'TXT-DICTIONARY' — Currently supports only TXT-DICTIONARY.
    - `PackageDescription` string — User-specified description of the package.
    - `PackageStatus` 'COPYING' | 'COPY_FAILED' | 'VALIDATING' | 'VALIDATION_FAILED' | 'AVAILABLE' | 'DELETING' | 'DELETED' | 'DELETE_FAILED' — Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
    - `CreatedAt` string, date-time — Timestamp which tells creation date of the package.
    - `LastUpdatedAt` string, date-time
    - `AvailablePackageVersion` string
    - `ErrorDetails` object — Additional information if the package is in an error state. Null otherwise.
      - `ErrorType` string
      - `ErrorMessage` string
  - `NextToken` string

## Other responses

- `480` — BaseException
- `481` — InternalException
- `482` — ResourceNotFoundException
- `483` — AccessDeniedException
- `484` — ValidationException

---

[API](https://skmtc.net/aws/apis/es.md) · [All operations](https://skmtc.net/aws/apis/es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/es/versions/2aa0f7663d92/schema)