Optional ReadonlyassignOptional ReadonlyclientUp to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
Optional ReadonlycommentA comment describing this state
Optional ReadonlycredentialsCredentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.
Optional ReadonlyheartbeatTimeout for the heartbeat
Optional ReadonlyheartbeatTimeout for the heartbeat
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Optional ReadonlyinputJSONPath 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 {}.
Optional ReadonlyintegrationAWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Optional ReadonlyinvocationInvocation type of the Lambda function
ReadonlylambdaLambda function to invoke
Optional ReadonlyoutputJSONPath 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 {}.
Optional ReadonlyoutputsUsed 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.
Optional ReadonlypayloadThe JSON that will be supplied as input to the Lambda function
Optional ReadonlypayloadInvoke the Lambda in a way that only returns the payload response without additional metadata.
The payloadResponseOnly property cannot be used if integrationPattern, invocationType,
clientContext, or qualifier are specified.
It always uses the REQUEST_RESPONSE behavior.
Optional ReadonlyqualifierVersion or alias to invoke a published version of the function
You only need to supply this if you want the version of the Lambda Function to depend
on data in the state machine state. If not, you can pass the appropriate Alias or Version object
directly as the lambdaFunction argument.
Optional ReadonlyqueryThe 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.
Optional ReadonlyresultJSONPath 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.
Optional ReadonlyresultThe JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
OptionalretriesOptional ReadonlyretryWhether to retry on Lambda service exceptions.
This handles Lambda.ServiceException, Lambda.AWSLambdaException,
Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException
with an interval of 2 seconds, a back-off rate
of 2 and 6 maximum attempts.
Optional ReadonlystateOptional name for this state
Optional ReadonlytaskTimeout for the task
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Optional ReadonlytimeoutTimeout for the task
Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.