Pass

The Pass state is internally used by the StepFunctions component to add a Pass workflow state to a state machine.

Note

This component is not intended to be created directly.

You’ll find this component returned by the pass method of the StepFunctions component.

---

Constructor

new Pass(args)

Parameters

• args PassArgs

PassArgs

assign?

Type Record<string, any>

Used to store variables. The Assign field accepts a JSON object with key/value pairs that define variable names and their assigned values. Alternatively, you can pass in a JSONata expression directly.

For more information, see Passing data between states with variables.

Provide a JSON object with variable names and values.

{
  assign: {
    productName: "product1",
    count: 42,
    available: true,
  }
}

Assign values from state input and result using JSONata expressions.

  {
    assign: {
      product: "{% $states.input.order.product %}",
      currentPrice: "{% $states.result.Payload.current_price %}"
    }
  }

comment?

Type Input<string>

A comment to describe the state.

name

Type string

The name of the state.

output?

Type Input<Record<string, any> | “{% ${string} %}”>

Specify and transform output from the state. When specified, the value overrides the state output default.

The output field accepts any JSON value (object, array, string, number, boolean, null). Alternatively, you can pass in a JSONata expression directly.

For more information, see Transforming data with JSONata in Step Functions.

Methods

next

next(state)

Parameters

• state State

  The state to transition to.

Returns State

Add a next state to the Pass state. If the state completes successfully, continue execution with the given state.