CallbackStep: Callback step for workflow.

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

Callback step for workflow.

Description

Callback step for workflow.

Callback step for workflow.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Step -> CallbackStep

Public fields

sqs_queue_url

An SQS queue URL for receiving callback messages.

inputs

Input arguments that will be provided in the SQS message body of callback messages

outputs

Outputs that can be provided when completing a callback.

cache_config

A list of step names this 'TransformStep'

Active bindings

arguments

The arguments dict that is used to define the callback step

properties

A Properties object representing the output parameters of the callback step.

Methods

Public methods

• CallbackStep$new()

• CallbackStep$to_request()

• CallbackStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

---

Method new()

Constructs a CallbackStep.

Usage

CallbackStep$new(
  name,
  sqs_queue_url,
  inputs,
  outputs,
  display_name = NULL,
  description = NULL,
  cache_config = NULL,
  depends_on = NULL
)

Arguments

name

(str): The name of the callback step.

sqs_queue_url

(str): An SQS queue URL for receiving callback messages.

inputs

(dict): Input arguments that will be provided in the SQS message body of callback messages.

outputs

(List[CallbackOutput]): Outputs that can be provided when completing a callback.

display_name

(str): The display name of the callback step.

description

(str): The description of the callback step.

cache_config

(CacheConfig): A 'CacheConfig' instance.

depends_on

(List[str]): A list of step names this 'TransformStep' depends on

---

Method to_request()

Updates the dictionary with cache configuration.

Usage

CallbackStep$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CallbackStep$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.