Pass

Define a Pass in the state machine.

A Pass state can be used to transform the current execution's state.

Source: aws-stepfunctions/lib/states/pass.ts
Type last changed: v2.178.0 · 6 Feb 2025

Example

   const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {
      stateMachineType: stepfunctions.StateMachineType.EXPRESS,
      definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),
   });

   const api = new apigateway.RestApi(this, 'Api', {
      restApiName: 'MyApi',
   });
   api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));

python

state_machine = stepfunctions.StateMachine(self, "MyStateMachine",
    state_machine_type=stepfunctions.StateMachineType.EXPRESS,
    definition=stepfunctions.Chain.start(stepfunctions.Pass(self, "Pass"))
)

api = apigateway.RestApi(self, "Api",
    rest_api_name="MyApi"
)
api.root.add_method("GET", apigateway.StepFunctionsIntegration.start_execution(state_machine))

java

StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
        .stateMachineType(StateMachineType.EXPRESS)
        .definition(Chain.start(new Pass(this, "Pass")))
        .build();

RestApi api = RestApi.Builder.create(this, "Api")
        .restApiName("MyApi")
        .build();
api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));

csharp

// Install: dotnet add package Amazon.CDK.Lib
var stateMachine = new StateMachine(this, "MyStateMachine", new StateMachineProps {
    StateMachineType = StateMachineType.EXPRESS,
    Definition = Chain.Start(new Pass(this, "Pass"))
});

var api = new RestApi(this, "Api", new RestApiProps {
    RestApiName = "MyApi"
});
api.Root.AddMethod("GET", StepFunctionsIntegration.StartExecution(stateMachine));

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
stateMachine := stepfunctions.NewStateMachine(this, jsii.String("MyStateMachine"), &StateMachineProps{
	StateMachineType: stepfunctions.StateMachineType_EXPRESS,
	Definition: stepfunctions.Chain_Start(stepfunctions.NewPass(this, jsii.String("Pass"))),
})

api := apigateway.NewRestApi(this, jsii.String("Api"), &RestApiProps{
	RestApiName: jsii.String("MyApi"),
})
api.Root.AddMethod(jsii.String("GET"), apigateway.StepFunctionsIntegration_StartExecution(stateMachine))

Initializer

new Pass(scope: Construct, id: string, props?: PassProps)

python

Pass(scope: Construct, id: str, props: typing.Optional[PassProps] = None)

java

new Pass(Construct scope, String id, PassProps props)

csharp

new Pass(Construct scope, string id, PassProps? props = null)

NewPass(Scope Construct, Id *string, Props PassProps)

Construct Props

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

Using workflow variables, you can store data in a step and retrieve that data in future steps.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

A comment describing this state.

Default: No comment

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#

Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

parametersoptional{ [key: string]: any }parametersoptionaltyping.Mapping[str, Any]parametersoptionalMap<String, Object>ParametersoptionalIDictionary<string, object>Parametersoptional*map[string]interface{}#

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Default: No parameters

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

resultoptionalResultresultoptionalResultresultoptionalResultResultoptionalResultResultoptionalResult#

If given, treat as the result of this operation.

Default: No injected result

Can be used to inject or replace the current execution state.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#

Optional name for this state.

Default: The construct ID will be used as state name

Properties

endStatesINextable[]end_statestyping.List[INextable]endStatesList<INextable>EndStatesINextable[]EndStates*[]INextablerequired#

Continuable states of this Chainable.

idstringidstridStringIdstringId*stringrequired#

Descriptive identifier for this chainable.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

startStateStatestart_stateStatestartStateStateStartStateStateStartStateStaterequired#

First state of this Chainable.

stateIdstringstate_idstrstateIdStringStateIdstringStateId*stringrequired#

Tokenized string that evaluates to the state's ID.

Methods

addPrefix(x: string): voiddef add_prefix(self, x: str) -> Nonepublic void addPrefix(String x)public void AddPrefix(string x)func AddPrefix(X *string)#

Add a prefix to the stateId of this state.

bindToGraph(graph: StateGraph): voiddef bind_to_graph(self, graph: StateGraph) -> Nonepublic void bindToGraph(StateGraph graph)public void BindToGraph(StateGraph graph)func BindToGraph(Graph StateGraph)#

Don't call this. It will be called automatically when you work with states normally.

filterNextables(states: State[]): INextable[]@staticmethod def filter_nextables(states: typing.List[State]) -> typing.List[INextable]public static List<INextable> filterNextables(List<State> states)public static INextable[] FilterNextables(State[] states)func FilterNextables(States *[]State) *[]INextablestatic#

Return only the states that allow chaining from an array of states.

findReachableEndStates(start: State, options?: FindStateOptions): State[]

@staticmethod def find_reachable_end_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]

public static List<State> findReachableEndStates(State start, FindStateOptions options)public static State[] FindReachableEndStates(State start, FindStateOptions? options = null)func FindReachableEndStates(Start State, Options FindStateOptions) *[]Statestatic#

Find the set of end states states reachable through transitions from the given start state.

findReachableStates(start: State, options?: FindStateOptions): State[]

@staticmethod def find_reachable_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]

public static List<State> findReachableStates(State start, FindStateOptions options)public static State[] FindReachableStates(State start, FindStateOptions? options = null)func FindReachableStates(Start State, Options FindStateOptions) *[]Statestatic#

Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

jsonata(scope: Construct, id: string, props?: PassJsonataProps): Pass // chainable@staticmethod def jsonata(scope: Construct, id: str, props: typing.Optional[PassJsonataProps] = None) -> Passpublic static Pass jsonata(Construct scope, String id, PassJsonataProps props)public static Pass Jsonata(Construct scope, string id, PassJsonataProps? props = null)func Jsonata(Scope Construct, Id *string, Props PassJsonataProps) Passstatic#

Define a Pass using JSONata in the state machine.

A Pass state can be used to transform the current execution's state.

jsonPath(scope: Construct, id: string, props?: PassJsonPathProps): Pass // chainable@staticmethod def json_path(scope: Construct, id: str, props: typing.Optional[PassJsonPathProps] = None) -> Passpublic static Pass jsonPath(Construct scope, String id, PassJsonPathProps props)public static Pass JsonPath(Construct scope, string id, PassJsonPathProps? props = null)func JsonPath(Scope Construct, Id *string, Props PassJsonPathProps) Passstatic#

Define a Pass using JSONPath in the state machine.

A Pass state can be used to transform the current execution's state.

next(next: IChainable): Chaindef next(self, next: IChainable) -> Chainpublic Chain next(IChainable next)public Chain Next(IChainable next)func Next(Next IChainable) Chain#

Continue normal execution with the given state.

prefixStates(root: IConstruct, prefix: string): void@staticmethod def prefix_states(root: IConstruct, prefix: str) -> Nonepublic static void prefixStates(IConstruct root, String prefix)public static void PrefixStates(IConstruct root, string prefix)func PrefixStates(Root IConstruct, Prefix *string)static#

Add a prefix to the stateId of all States found in a construct tree.

toStateJson(topLevelQueryLanguage?: QueryLanguage): jsondef to_state_json(self, top_level_query_language: typing.Optional[QueryLanguage] = None) -> Anypublic Object toStateJson(QueryLanguage topLevelQueryLanguage)public object ToStateJson(QueryLanguage? topLevelQueryLanguage = null)func ToStateJson(TopLevelQueryLanguage QueryLanguage) interface{}#

Return the Amazon States Language object for this state.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining

Pass ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Pass

Example

Initializer

Construct Props

Properties

Methods