Skip to content

Delay State

- id: a
  type: delay
  duration: PT10S

DelayStateDefinition

If the workflow needs to pause for a specific length of time, the delay state is usually the simplest way to do that.

Parameter Description Type Required
type Identifies which kind of StateDefinition is being used. In this case it must be set to delay. string yes
id An identifier unique within the workflow to this one state. string yes
log If defined, the workflow will generate a log when it commences this state. See StateLogging. Structured JQ no
metadata If defined, updates the instance's metadata. See InstanceMetadata. Structured JQ no
transform If defined, modifies the instance's data upon completing the state logic. See StateTransforms. Structured JQ no
transition Identifies which state to transition to next, referring to the next state's unique id. If undefined, this state terminates the workflow. string no
catch Defines behaviour for handling of catchable errors. []ErrorCatchDefinition no
duration An ISO8601 duration string. string yes
Back to top