Wait: Wait State Class

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

Description

Wait state causes the interpreter to delay the machine from continuing for a specified time. The time can be specified as a wait duration, specified in seconds, or an absolute expiry time, specified as an ISO-8601 extended offset date-time format string.

Super classes

stepfunctions::Block -> stepfunctions::State -> Wait

Methods

Public methods

• Wait$new()

• Wait$allowed_fields()

• Wait$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()

---

Method new()

The Wait state **must contain exactly one** of 'seconds', 'seconds_path', 'timestamp', or 'timestamp_path'.

Usage

Wait$new(
  state_id,
  seconds = NULL,
  seconds_path = NULL,
  timestamp = NULL,
  timestamp_path = NULL,
  comment = NULL,
  input_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.

seconds

(int): Wait duration specified in seconds.

seconds_path

(str): Path applied to the state's input to select the wait duration in seconds.

timestamp

(str): Absolute expiry time, specified as an ISO-8601 extended offset date-time format string.

timestamp_path

(str): Path applied to the state's input to select the timestamp to be used for wait duration.

comment

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

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: '$')

output_path

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

...

: Extra field names to pass to Block class

---

Method allowed_fields()

allowed extra fields

Usage

Wait$allowed_fields()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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