pipeline_execution_steps

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

Overview

Name	pipeline_execution_steps
Type	Resource
Id	aws.sagemaker.pipeline_execution_steps

Fields

The following fields are returned by SELECT queries:

list_pipeline_execution_steps

Name	Datatype	Description
attempt_count	integer	The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
cache_hit_result	object	If this pipeline execution step was cached, details on the cache hit.
end_time	string (date-time)	The time that the step stopped executing.
failure_reason	string	The reason why the step failed execution. This is only returned if the step failed its execution.
metadata	object	Metadata to run the pipeline step.
selective_execution_result	object	The ARN from an execution of the current pipeline from which results are reused for this step.
start_time	string (date-time)	The time that the step started executing.
step_description	string	The description of the step. (pattern: <code>.*</code>)
step_display_name	string	The display name of the step. (pattern: <code>.*</code>)
step_name	string	The name of the step that is executed. (pattern: <code>[A-Za-z0-9-_]*</code>)
step_status	string	The status of the step execution. (Starting, Executing, Stopping, Stopped, Failed, Succeeded)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pipeline_execution_steps	select	region		Gets a list of PipeLineExecutionStep objects.
send_pipeline_execution_step_failure	exec	region, CallbackToken		Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
send_pipeline_execution_step_success	exec	region, CallbackToken		Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

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

list_pipeline_execution_steps

Gets a list of PipeLineExecutionStep objects.

SELECT
attempt_count,
cache_hit_result,
end_time,
failure_reason,
metadata,
selective_execution_result,
start_time,
step_description,
step_display_name,
step_name,
step_status
FROM aws.sagemaker.pipeline_execution_steps
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

send_pipeline_execution_step_failure

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

EXEC aws.sagemaker.pipeline_execution_steps.send_pipeline_execution_step_failure 
@region='{{ region }}' --required 
@@json=
'{
"CallbackToken": "{{ CallbackToken }}", 
"FailureReason": "{{ FailureReason }}", 
"ClientRequestToken": "{{ ClientRequestToken }}"
}'
;

send_pipeline_execution_step_success

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

EXEC aws.sagemaker.pipeline_execution_steps.send_pipeline_execution_step_success 
@region='{{ region }}' --required 
@@json=
'{
"CallbackToken": "{{ CallbackToken }}", 
"OutputParameters": "{{ OutputParameters }}", 
"ClientRequestToken": "{{ ClientRequestToken }}"
}'
;