pipeline_change_progress

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

Overview

Name	pipeline_change_progress
Type	Resource
Id	aws.osis.pipeline_change_progress

Fields

The following fields are returned by SELECT queries:

get_pipeline_change_progress

Name	Datatype	Description
change_progress_statuses	array	The current status of the change happening on the pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline_change_progress	select	pipeline_name, region		Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.

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
pipeline_name	string	The name of the pipeline.
region	string	AWS region (default: us-east-1)

SELECT examples

get_pipeline_change_progress

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.

SELECT
change_progress_statuses
FROM aws.osis.pipeline_change_progress
WHERE pipeline_name = '{{ pipeline_name }}' -- required
AND region = '{{ region }}' -- required
;