upgrade_status

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

Overview

Name	upgrade_status
Type	Resource
Id	aws.opensearch.upgrade_status

Fields

The following fields are returned by SELECT queries:

get_upgrade_status

Name	Datatype	Description
step_status	string	The status of the current step that an upgrade is on. (IN_PROGRESS, SUCCEEDED, SUCCEEDED_WITH_ISSUES, FAILED)
upgrade_name	string	A string that describes the update.
upgrade_step	string	One of three steps that an upgrade or upgrade eligibility check goes through. (PRE_UPGRADE_CHECK, SNAPSHOT, UPGRADE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upgrade_status	select	domain_name, region		Returns the most recent status of the last upgrade or upgrade eligibility check 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 domain of the domain to get upgrade status information for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_upgrade_status

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

SELECT
step_status,
upgrade_name,
upgrade_step
FROM aws.opensearch.upgrade_status
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;