ApiGatewayStep: ApiGatewayStep class

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

Description

Creates a Task state to invoke api gateway with Step Functions https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html for more details.

Super classes

stepfunctions::Block -> stepfunctions::State -> stepfunctions::Task -> ApiGateway

Methods

Public methods

• ApiGatewayStep$new()

• ApiGatewayStep$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 ApiGatewayStep task class

Usage

ApiGatewayStep$new(
  state_id,
  wait_for_callback = FALSE,
  comment = NULL,
  timeout_seconds = NULL,
  timeout_seconds_path = NULL,
  heartbeat_seconds = NULL,
  heartbeat_seconds_path = NULL,
  input_path = NULL,
  parameters = NULL,
  result_path = NULL,
  output_path = NULL,
  ...
)

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.

wait_for_callback

(bool, optional): Boolean value set to 'True' if the Task state should wait for callback to resume the operation. (default: False)

comment

(str, optional): Human-readable comment or description. (default: None)

timeout_seconds

(int, optional): Positive integer specifying timeout for the state in seconds. If the state runs longer than the specified timeout, then the interpreter fails the state with a 'States.Timeout' Error Name. (default: 60)

timeout_seconds_path

(str, optional): Path specifying the state's timeout value in seconds from the state input. When resolved, the path must select a field whose value is a positive integer.

heartbeat_seconds

(int, optional): Positive integer specifying heartbeat timeout for the state in seconds. This value should be lower than the one specified for 'timeout_seconds'. If more time than the specified heartbeat elapses between heartbeats from the task, then the interpreter fails the state with a 'States.Timeout' Error Name.

heartbeat_seconds_path

(str, optional): Path specifying the state's heartbeat value in seconds from the state input. When resolved, the path must select a field whose value is a positive integer.

input_path

(str, optional): Path applied to the state’s raw input to select some or all of it; that selection is used by the state. (default: '$')

parameters

(list, optional): The value of this field becomes the effective input for the state.

result_path

(str, optional): Path specifying the raw input’s combination with or replacement by the state’s result. (default: '$')

output_path

(str, optional): Path applied to the state’s output after the application of 'result_path', producing the effective output which serves as the raw input for the next state. (default: '$')

...

: Extra Fields passed to Task class

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ApiGatewayStep$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

This class only calls another stepfunction state machine from the "parent" state machine.

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