TaskInput

class aws_cdk.aws_stepfunctions.TaskInput(*args: Any, **kwargs)

Bases: object

Type union for task classes that accept multiple types of payload.

ExampleMetadata:: infused

Example:

import aws_cdk.aws_apigateway as apigateway
# api: apigateway.RestApi


tasks.CallApiGatewayRestApiEndpoint.jsonata(self, "Endpoint",
    api=api,
    stage_name="Stage",
    method=tasks.HttpMethod.PUT,
    integration_pattern=sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
    headers=sfn.TaskInput.from_object({
        "TaskToken": "{% States.Array($states.context.taskToken) %}"
    })
)

Attributes

type: type of task input.

value

payload for the corresponding input type.

It can be a JSON-encoded object, context, data, etc.

Static Methods

classmethod from_json_path_at(path)

Use a part of the execution data or task context as task input.

Use this when you want to use a subobject or string from the current state machine execution or the current task context as complete payload to a task.

Parameters:: path (str)
Return type:: TaskInput

classmethod from_object(obj)

Use an object as task input.

This object may contain JSON path fields as object values, if desired.

Use sfn.JsonPath.DISCARD in place of null for languages that do not support null (i.e. Python).

Parameters:: obj (Mapping[str, Any])
Return type:: TaskInput

classmethod from_text(text)

Use a literal string as task input.

This might be a JSON-encoded object, or just a text.

Parameters:: text (str)
Return type:: TaskInput