LambdaInvokeProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
LambdaInvokeProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, lambda_function, client_context=None, invocation_type=None, payload=None, payload_response_only=None, qualifier=None, retry_on_service_exceptions=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for invoking a Lambda function with LambdaInvoke.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – 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 {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSEoutput_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – 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. Default: - Replaces the entire input with the result (JSON path ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonelambda_function (
IFunction
) – Lambda function to invoke.client_context (
Optional
[str
]) – Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function. Default: - No contextinvocation_type (
Optional
[LambdaInvocationType
]) – Invocation type of the Lambda function. Default: InvocationType.REQUEST_RESPONSEpayload (
Optional
[TaskInput
]) – The JSON that will be supplied as input to the Lambda function. Default: - The state input (JSON path ‘$’)payload_response_only (
Optional
[bool
]) – Invoke the Lambda in a way that only returns the payload response without additional metadata. ThepayloadResponseOnly
property cannot be used ifintegrationPattern
,invocationType
,clientContext
, orqualifier
are specified. It always uses the REQUEST_RESPONSE behavior. Default: falsequalifier (
Optional
[str
]) – Version 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 thelambdaFunction
argument. Default: - Version or alias inherent to thelambdaFunction
object.retry_on_service_exceptions (
Optional
[bool
]) – Whether to retry on Lambda service exceptions. This handlesLambda.ServiceException
,Lambda.AWSLambdaException
andLambda.SdkClientException
with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts. Default: true
Attributes
-
client_context
¶ Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
- Default
No context
- Return type
Optional
[str
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
input_path
¶ 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 {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
invocation_type
¶ Invocation type of the Lambda function.
- Default
InvocationType.REQUEST_RESPONSE
- Return type
Optional
[LambdaInvocationType
]
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
payload
¶ The JSON that will be supplied as input to the Lambda function.
- Default
The state input (JSON path ‘$’)
- Return type
Optional
[TaskInput
]
-
payload_response_only
¶ Invoke the Lambda in a way that only returns the payload response without additional metadata.
The
payloadResponseOnly
property cannot be used ifintegrationPattern
,invocationType
,clientContext
, orqualifier
are specified. It always uses the REQUEST_RESPONSE behavior.- Default
false
- Return type
Optional
[bool
]
-
qualifier
¶ Version 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.- Default
Version or alias inherent to the
lambdaFunction
object.
- Return type
Optional
[str
]
-
result_path
¶ 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.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
retry_on_service_exceptions
¶ Whether to retry on Lambda service exceptions.
This handles
Lambda.ServiceException
,Lambda.AWSLambdaException
andLambda.SdkClientException
with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.- Default
true
- See
https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html
- Return type
Optional
[bool
]