dot-PipeLineExecution: Workflow .PipelineExecution class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

Workflow .PipelineExecution class

Description

Internal class for encapsulating pipeline execution instances.

Public fields

arn

The arn of the pipeline execution

sagemaker_session

Session object which manages interactions with Amazon SageMaker

Methods

Public methods

• .PipelineExecution$new()

• .PipelineExecution$stop()

• .PipelineExecution$describe()

• .PipelineExecution$list_steps()

• .PipelineExecution$wait()

• .PipelineExecution$format()

• .PipelineExecution$clone()

---

Method new()

Initialize .PipeLineExecution class

Usage

.PipelineExecution$new(arn, sagemaker_session = NULL)

Arguments

arn

(str): The arn of the pipeline execution.

sagemaker_session

(sagemaker.session.Session): Session object which manages interactions with Amazon SageMaker APIs and any other AWS services needed. If not specified, the pipeline creates one using the default AWS configuration chain.

---

Method stop()

Stops a pipeline execution.

Usage

.PipelineExecution$stop()

---

Method describe()

Describes a pipeline execution.

Usage

.PipelineExecution$describe()

Returns

Information about the pipeline execution. See 'boto3 client describe_pipeline_execution https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.describe_pipeline_execution.

---

Method list_steps()

Describes a pipeline execution's steps.

Usage

.PipelineExecution$list_steps()

Returns

Information about the steps of the pipeline execution. See 'boto3 client list_pipeline_execution_steps https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.list_pipeline_execution_steps.

---

Method wait()

Waits for a pipeline execution.

Usage

.PipelineExecution$wait(delay = 30, max_attempts = 60)

Arguments

delay

(int): The polling interval. (Defaults to 30 seconds)

max_attempts

(int): The maximum number of polling attempts. (Defaults to 60 polling attempts)

---

Method format()

format class

Usage

.PipelineExecution$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

.PipelineExecution$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.