domain_change_progress

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

Overview

Name	domain_change_progress
Type	Resource
Id	aws.opensearch.domain_change_progress

Fields

The following fields are returned by SELECT queries:

describe_domain_change_progress

Name	Datatype	Description
change_id	string	The unique change identifier associated with a specific domain configuration change. (pattern: <code>\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}</code>)
change_progress_stages	array	The specific stages that the domain is going through to perform the configuration change.
completed_properties	array	The list of properties in the domain configuration change that have completed.
config_change_status	string	The current status of the configuration change. (Pending, Initializing, Validating, ValidationFailed, ApplyingChanges, Completed, PendingUserInput, Cancelled)
initiated_by	string	The IAM principal who initiated the configuration change. (CUSTOMER, SERVICE)
last_updated_time	string (date-time)	The last time that the status of the configuration change was updated.
pending_properties	array	The list of properties in the domain configuration change that are still pending.
start_time	string (date-time)	The time at which the configuration change is made on the domain.
status	string	The overall status of the domain configuration change. (PENDING, PROCESSING, COMPLETED, FAILED)
total_number_of_stages	integer	The total number of stages required for the configuration change.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_change_progress	select	domain_name, region	changeid	Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in 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
domain_name	string	The name of the domain to get progress information for.
region	string	AWS region (default: us-east-1)
changeid	string	The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

SELECT examples

describe_domain_change_progress

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

SELECT
change_id,
change_progress_stages,
completed_properties,
config_change_status,
initiated_by,
last_updated_time,
pending_properties,
start_time,
status,
total_number_of_stages
FROM aws.opensearch.domain_change_progress
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND changeid = '{{ changeid }}'
;