pipeline_executions

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

Overview

Name	pipeline_executions
Type	Resource
Id	aws.codepipeline.pipeline_executions

Fields

The following fields are returned by SELECT queries:

get_pipeline_execution

Name	Datatype	Description
artifact_revisions	array	A list of ArtifactRevision objects included in a pipeline execution.
execution_mode	string	The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. (QUEUED, SUPERSEDED, PARALLEL)
execution_type	string	The type of the pipeline execution. (STANDARD, ROLLBACK)
pipeline_execution_id	string	The ID of the pipeline execution. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
pipeline_name	string	The name of the pipeline with the specified pipeline execution. (pattern: <code>[A-Za-z0-9.@-_]+</code>)
pipeline_version	integer	The version number of the pipeline with the specified pipeline execution.
rollback_metadata	object	The metadata about the execution pertaining to stage rollback.
status	string	The status of the pipeline execution. Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully. (Cancelled, InProgress, Stopped, Stopping, Succeeded, Superseded, Failed)
status_summary	string	A summary that contains a description of the pipeline execution status.
trigger	object	The interaction or event that started a pipeline execution.
variables	array	A list of pipeline variables used for the pipeline execution.

list_pipeline_executions

Name	Datatype	Description
execution_mode	string	The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. (QUEUED, SUPERSEDED, PARALLEL)
execution_type	string	Type of the pipeline execution. (STANDARD, ROLLBACK)
last_update_time	string (date-time)	The date and time of the last change to the pipeline execution, in timestamp format.
pipeline_execution_id	string	The ID of the pipeline execution. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
rollback_metadata	object	The metadata for the stage execution to be rolled back.
source_revisions	array	A list of the source artifact revisions that initiated a pipeline execution.
start_time	string (date-time)	The date and time when the pipeline execution began, in timestamp format.
status	string	The status of the pipeline execution. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully. (Cancelled, InProgress, Stopped, Stopping, Succeeded, Superseded, Failed)
status_summary	string	Status summary for the pipeline.
stop_trigger	object	The interaction that stopped a pipeline execution.
trigger	object	The interaction or event that started a pipeline execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline_execution	select	region		Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
list_pipeline_executions	select	region		Gets a summary of the most recent executions for a pipeline. When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
override_stage_condition	exec	region, pipelineName, stageName, pipelineExecutionId, conditionType		Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.
retry_stage_execution	exec	region, pipelineName, stageName, pipelineExecutionId, retryMode		You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_pipeline_execution

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

SELECT
artifact_revisions,
execution_mode,
execution_type,
pipeline_execution_id,
pipeline_name,
pipeline_version,
rollback_metadata,
status,
status_summary,
trigger,
variables
FROM aws.codepipeline.pipeline_executions
WHERE region = '{{ region }}' -- required
;

list_pipeline_executions

Gets a summary of the most recent executions for a pipeline. When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.

SELECT
execution_mode,
execution_type,
last_update_time,
pipeline_execution_id,
rollback_metadata,
source_revisions,
start_time,
status,
status_summary,
stop_trigger,
trigger
FROM aws.codepipeline.pipeline_executions
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

override_stage_condition

Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.

EXEC aws.codepipeline.pipeline_executions.override_stage_condition 
@region='{{ region }}' --required 
@@json=
'{
"pipelineName": "{{ pipelineName }}", 
"stageName": "{{ stageName }}", 
"pipelineExecutionId": "{{ pipelineExecutionId }}", 
"conditionType": "{{ conditionType }}"
}'
;

retry_stage_execution

You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

EXEC aws.codepipeline.pipeline_executions.retry_stage_execution 
@region='{{ region }}' --required 
@@json=
'{
"pipelineName": "{{ pipelineName }}", 
"stageName": "{{ stageName }}", 
"pipelineExecutionId": "{{ pipelineExecutionId }}", 
"retryMode": "{{ retryMode }}"
}'
;