upgrade_histories

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

Overview

Name	upgrade_histories
Type	Resource
Id	aws.opensearch.upgrade_histories

Fields

The following fields are returned by SELECT queries:

get_upgrade_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.
upgrade_histories	array	A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upgrade_history	select	domain_name, region	maxResults, nextToken	Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

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
domain_name	string	The name of an existing domain.
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 GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

SELECT examples

get_upgrade_history

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

SELECT
next_token,
upgrade_histories
FROM aws.opensearch.upgrade_histories
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;