---
title: "GET /2021-01-01/domain/{DomainName}/packages"
method: GET
path: "/2021-01-01/domain/{DomainName}/packages"
---

# GET /2021-01-01/domain/{DomainName}/packages

`GET /2021-01-01/domain/{DomainName}/packages`

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.

## Path parameters

- `DomainName` string, required — The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

## Query parameters

- `maxResults` integer — An optional parameter that specifies the maximum number of results to return for a given request.
- `nextToken` string — When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

## Response `200`

Success

- ListPackagesForDomainResponse — Container for the response parameters to the <code>ListPackagesForDomain</code> operation.
  - `DomainPackageDetailsList` DomainPackageDetails[] — List of all packages associated with a domain.
    - `PackageID` string — Internal ID of the package.
    - `PackageName` string — User-specified name of the package.
    - `PackageType` 'TXT-DICTIONARY' | 'ZIP-PLUGIN' | 'PACKAGE-LICENSE' | 'PACKAGE-CONFIG' — The type of package.
    - `LastUpdated` string, date-time — Timestamp of the most recent update to the package association status.
    - `DomainName` string — Name of the domain that the package is associated with.
    - `DomainPackageStatus` 'ASSOCIATING' | 'ASSOCIATION_FAILED' | 'ACTIVE' | 'DISSOCIATING' | 'DISSOCIATION_FAILED' — State of the association.
    - `PackageVersion` string — The current version of the package.
    - `PrerequisitePackageIDList` PackageID[] — A list of package IDs that must be associated with the domain before or with the package can be associated.
    - `ReferencePath` string — The relative path of the package on the OpenSearch Service cluster nodes. This is <code>synonym_path</code> when the package is for synonym files.
    - `ErrorDetails` object — Additional information if the package is in an error state. Null otherwise.
      - `ErrorType` string — The type of error that occurred.
      - `ErrorMessage` string — A message describing the error.
    - `AssociationConfiguration` object — The configuration for associating a package with an Amazon OpenSearch Service domain.
      - `KeyStoreAccessOption` object — The configuration parameters to enable accessing the key store required by the package.
        - `KeyAccessRoleArn` string — Role ARN to access the KeyStore Key
        - `KeyStoreAccessEnabled` boolean, required — This indicates whether Key Store access is enabled
  - `NextToken` string — When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

## Other responses

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

---

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