upgrade_histories

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

Overview

Name	upgrade_histories
Type	Resource
Id	aws.es.upgrade_histories

Fields

The following fields are returned by SELECT queries:

get_upgrade_history

Name	Datatype	Description
start_timestamp	string (date-time)	UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
steps_list	array	A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.
upgrade_name	string	A string that describes the update briefly
upgrade_status	string	The overall status of the update. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed (IN_PROGRESS, SUCCEEDED, SUCCEEDED_WITH_ISSUES, FAILED)

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 that were performed on the 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
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

get_upgrade_history

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

SELECT
start_timestamp,
steps_list,
upgrade_name,
upgrade_status
FROM aws.es.upgrade_histories
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;