pipeline_executions

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

Overview

Name	pipeline_executions
Type	Resource
Id	aws.sagemaker.pipeline_executions

Fields

The following fields are returned by SELECT queries:

describe_pipeline_execution

Name	Datatype	Description
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	The time when the pipeline execution was created.
failure_reason	string	If the execution failed, a message describing why. (pattern: <code>.*</code>)
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	The time when the pipeline execution was modified last.
m_lflow_config	object	The MLflow configuration of the pipeline execution.
parallelism_configuration	object	The parallelism configuration applied to the pipeline.
pipeline_arn	string	The Amazon Resource Name (ARN) of the pipeline. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:([0-9]{12}|aws):pipeline/.*</code>)
pipeline_execution_arn	string	The Amazon Resource Name (ARN) of the pipeline execution. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:pipeline/./execution/.</code>)
pipeline_execution_description	string	The description of the pipeline execution. (pattern: <code>.*</code>)
pipeline_execution_display_name	string	The display name of the pipeline execution. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}</code>)
pipeline_execution_status	string	The status of the pipeline execution. (Executing, Stopping, Stopped, Failed, Succeeded)
pipeline_experiment_config	object	Specifies the names of the experiment and trial created by a pipeline.
pipeline_version_id	integer (int64)	The ID of the pipeline version.
selective_execution_config	object	The selective execution configuration applied to the pipeline run.

list_pipeline_executions

Name	Datatype	Description
pipeline_execution_arn	string	The Amazon Resource Name (ARN) of the pipeline execution. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:pipeline/./execution/.</code>)
pipeline_execution_description	string	The description of the pipeline execution. (pattern: <code>.*</code>)
pipeline_execution_display_name	string	The display name of the pipeline execution. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}</code>)
pipeline_execution_failure_reason	string	A message generated by SageMaker Pipelines describing why the pipeline execution failed.
pipeline_execution_status	string	The status of the pipeline execution. (Executing, Stopping, Stopped, Failed, Succeeded)
start_time	string (date-time)	The start time of the pipeline execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_pipeline_execution	select	region		Describes the details of a pipeline execution.
list_pipeline_executions	select	region		Gets a list of the pipeline executions.
update_pipeline_execution	update	region, PipelineExecutionArn		Updates a pipeline execution.
retry_pipeline_execution	exec	region, PipelineExecutionArn, ClientRequestToken		Retry the execution of the pipeline.

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

describe_pipeline_execution

Describes the details of a pipeline execution.

SELECT
created_by,
creation_time,
failure_reason,
last_modified_by,
last_modified_time,
m_lflow_config,
parallelism_configuration,
pipeline_arn,
pipeline_execution_arn,
pipeline_execution_description,
pipeline_execution_display_name,
pipeline_execution_status,
pipeline_experiment_config,
pipeline_version_id,
selective_execution_config
FROM aws.sagemaker.pipeline_executions
WHERE region = '{{ region }}' -- required
;

list_pipeline_executions

Gets a list of the pipeline executions.

SELECT
pipeline_execution_arn,
pipeline_execution_description,
pipeline_execution_display_name,
pipeline_execution_failure_reason,
pipeline_execution_status,
start_time
FROM aws.sagemaker.pipeline_executions
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_pipeline_execution

Updates a pipeline execution.

UPDATE aws.sagemaker.pipeline_executions
SET 
PipelineExecutionArn = '{{ PipelineExecutionArn }}',
PipelineExecutionDescription = '{{ PipelineExecutionDescription }}',
PipelineExecutionDisplayName = '{{ PipelineExecutionDisplayName }}',
ParallelismConfiguration = '{{ ParallelismConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND PipelineExecutionArn = '{{ PipelineExecutionArn }}' --required
RETURNING
pipeline_execution_arn;

Lifecycle Methods

retry_pipeline_execution

Retry the execution of the pipeline.

EXEC aws.sagemaker.pipeline_executions.retry_pipeline_execution 
@region='{{ region }}' --required 
@@json=
'{
"PipelineExecutionArn": "{{ PipelineExecutionArn }}", 
"ClientRequestToken": "{{ ClientRequestToken }}", 
"ParallelismConfiguration": "{{ ParallelismConfiguration }}"
}'
;