dry_run_progress

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

Overview

Name	dry_run_progress
Type	Resource
Id	aws.opensearch.dry_run_progress

Fields

The following fields are returned by SELECT queries:

describe_dry_run_progress

Name	Datatype	Description
dry_run_config	object	The current status of an OpenSearch Service domain.
dry_run_progress_status	object	The current status of the dry run, including any validation errors.
dry_run_results	object	The results of the dry run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dry_run_progress	select	domain_name, region	dryRunId, loadDryRunConfig	Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

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.
region	string	AWS region (default: us-east-1)
dryRunId	string	The unique identifier of the dry run.
loadDryRunConfig	boolean	Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.

SELECT examples

describe_dry_run_progress

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

SELECT
dry_run_config,
dry_run_progress_status,
dry_run_results
FROM aws.opensearch.dry_run_progress
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND dryRunId = '{{ dryRunId }}'
AND loadDryRunConfig = '{{ loadDryRunConfig }}'
;