EndpointStep: Sagemaker EndpointStep task class

In DyfanJones/aws-step-functions-data-science-sdk-r: R SDK for `AWS Stepfunctions`

Description

Creates a Task State to create https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html or update https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html an endpoint in SageMaker.

Super classes

stepfunctions::Block -> stepfunctions::State -> stepfunctions::Task -> EndpointStep

Methods

Public methods

• EndpointStep$new()

• EndpointStep$clone()

Inherited methods

• stepfunctions::Block$is_field_allowed()

• stepfunctions::Block$to_json()

• stepfunctions::State$.next()

• stepfunctions::State$accept()

• stepfunctions::State$add_catch()

• stepfunctions::State$add_retry()

• stepfunctions::State$format()

• stepfunctions::State$output()

• stepfunctions::State$to_list()

• stepfunctions::State$update_parameters()

• stepfunctions::Task$allowed_fields()

---

Method new()

Initialize EndpointStep Class

Usage

EndpointStep$new(
  state_id,
  endpoint_name,
  endpoint_config_name,
  tags = NULL,
  update = FALSE,
  ...
)

Arguments

state_id

(str): State name whose length **must be** less than or equal to 128 unicode characters. State names **must be** unique within the scope of the whole state machine.

endpoint_name

(str or Placeholder): The name of the endpoint to create. We recommend to use :py:class:'~stepfunctions.inputs.ExecutionInput' placeholder collection to pass the value dynamically in each execution.

endpoint_config_name

(str or Placeholder): The name of the endpoint configuration to use for the endpoint. We recommend to use :py:class: '~stepfunctions.inputs.ExecutionInput' placeholder collection to pass the value dynamically in each execution.

tags

(list[list], optional): 'List to tags' https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html to associate with the resource.

update

(bool, optional): Boolean flag set to 'True' if endpoint must to be updated. Set to 'False' if new endpoint must be created. (default: False)

...

: Extra Fields passed to Task class

---

Method clone()

The objects of this class are cloneable with this method.

Usage

EndpointStep$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/aws-step-functions-data-science-sdk-r documentation built on Dec. 17, 2021, 5:31 p.m.