package_version_histories

Creates, updates, deletes, gets or lists a package_version_histories resource.

Overview

Name	package_version_histories
Type	Resource
Id	aws.opensearch.package_version_histories

Fields

The following fields are returned by SELECT queries:

get_package_version_history

Name	Datatype	Description
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
package_id	string	The unique identifier of the package. (pattern: <code>^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$</code>)
package_version_history_list	array	A list of package versions, along with their creation time and commit message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_package_version_history	select	package_id, region	maxResults, nextToken	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 Custom packages for Amazon OpenSearch Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
package_id	string	The unique identifier of the package.
region	string	AWS region (default: us-east-1)
maxResults	integer	An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken	string	If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

SELECT examples

get_package_version_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 Custom packages for Amazon OpenSearch Service.

SELECT
next_token,
package_id,
package_version_history_list
FROM aws.opensearch.package_version_histories
WHERE package_id = '{{ package_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;