Skip to content

PipelineExecutionStep

Source code in docs_src/capo_sagemaker/types/pipeline_execution_step.py
class PipelineExecutionStep(TypedDict, closed=True):
    step_name: NotRequired["capo_sagemaker.types.step_name.StepName"]
    """<p>The name of the step that is executed.</p>"""
    step_display_name: NotRequired[
        "capo_sagemaker.types.step_display_name.StepDisplayName"
    ]
    """<p>The display name of the step.</p>"""
    step_description: NotRequired[
        "capo_sagemaker.types.step_description.StepDescription"
    ]
    """<p>The description of the step.</p>"""
    start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time that the step started executing.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time that the step stopped executing.</p>"""
    step_status: NotRequired["capo_sagemaker.types.step_status.StepStatus"]
    """<p>The status of the step execution.</p>"""
    cache_hit_result: NotRequired[
        "capo_sagemaker.types.cache_hit_result.CacheHitResult"
    ]
    """<p>If this pipeline execution step was cached, details on the cache hit.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The reason why the step failed execution. This is only returned if the step failed its execution.</p>"""
    metadata: NotRequired[
        "capo_sagemaker.types.pipeline_execution_step_metadata.PipelineExecutionStepMetadata"
    ]
    """<p>Metadata to run the pipeline step.</p>"""
    attempt_count: NotRequired["capo_sagemaker.types.integer.Integer"]
    """<p>The current attempt of the execution step. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html">Retry Policy for SageMaker Pipelines steps</a>.</p>"""
    selective_execution_result: NotRequired[
        "capo_sagemaker.types.selective_execution_result.SelectiveExecutionResult"
    ]
    """<p>The ARN from an execution of the current pipeline from which results are reused for this step.</p>"""
    iteration_context: NotRequired[
        "capo_sagemaker.types.iteration_context.IterationContext"
    ]
    """<p>The context for the iteration of a ForEach step that generated this step execution.</p>"""

attempt_count instance-attribute

attempt_count: NotRequired[Integer]

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

cache_hit_result instance-attribute

cache_hit_result: NotRequired[CacheHitResult]

If this pipeline execution step was cached, details on the cache hit.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time that the step stopped executing.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The reason why the step failed execution. This is only returned if the step failed its execution.

iteration_context instance-attribute

iteration_context: NotRequired[IterationContext]

The context for the iteration of a ForEach step that generated this step execution.

metadata instance-attribute

metadata: NotRequired[PipelineExecutionStepMetadata]

Metadata to run the pipeline step.

selective_execution_result instance-attribute

selective_execution_result: NotRequired[SelectiveExecutionResult]

The ARN from an execution of the current pipeline from which results are reused for this step.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The time that the step started executing.

step_description instance-attribute

step_description: NotRequired[StepDescription]

The description of the step.

step_display_name instance-attribute

step_display_name: NotRequired[StepDisplayName]

The display name of the step.

step_name instance-attribute

step_name: NotRequired[StepName]

The name of the step that is executed.

step_status instance-attribute

step_status: NotRequired[StepStatus]

The status of the step execution.