---
title: "GET /2021-01-01/packages/{PackageID}/history"
method: GET
path: "/2021-01-01/packages/{PackageID}/history"
---

# GET /2021-01-01/packages/{PackageID}/history

`GET /2021-01-01/packages/{PackageID}/history`

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). 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

- `PackageID` string, required

## 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

- GetPackageVersionHistoryResponse — Container for response returned by <code>GetPackageVersionHistory</code> operation.
  - `PackageID` string — The unique identifier of the package.
  - `PackageVersionHistoryList` PackageVersionHistory[] — A list of package versions, along with their creation time and commit message.
    - `PackageVersion` string — The package version.
    - `CommitMessage` string — A message associated with the package version when it was uploaded.
    - `CreatedAt` string, date-time — The date and time when the package was created.
    - `PluginProperties` object — Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code> package.
      - `Name` string — The name of the plugin.
      - `Description` string — The description of the plugin.
      - `Version` string — The version of the plugin.
      - `ClassName` string — The name of the class to load.
      - `UncompressedSizeInBytes` integer — The uncompressed size of the plugin.
    - `PackageConfiguration` object — The configuration details for a specific version of a package.
      - `LicenseRequirement` 'REQUIRED' | 'OPTIONAL' | 'NONE', required — The license requirements for the package.
      - `LicenseFilepath` string — The relative file path for the license associated with the package.
      - `ConfigurationRequirement` 'REQUIRED' | 'OPTIONAL' | 'NONE', required — The configuration requirements for the package.
      - `RequiresRestartForConfigurationUpdate` boolean — This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.
  - `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/revisions/e747e56ee8c6/schema)