interface JsonataStateOptions

Language	Type name
.NET	`Amazon.CDK.AWS.StepFunctions.JsonataStateOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#JsonataStateOptions`
Java	`software.amazon.awscdk.services.stepfunctions.JsonataStateOptions`
Python	`aws_cdk.aws_stepfunctions.JsonataStateOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_stepfunctions` » `JsonataStateOptions`

Option properties for JSONata task state.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';

declare const arguments_: any;
declare const outputs: any;
const jsonataStateOptions: stepfunctions.JsonataStateOptions = {
  arguments: arguments_,
  outputs: outputs,
};

Properties

Name	Type	Description
arguments?	`any`	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
outputs?	`any`	Used to specify and transform output from the state.

arguments?

Type: any (optional, default: No arguments)

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

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to 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). 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.

Select your cookie preferences