Skip to content

TaskScheduledEventDetails

Source code in docs_src/capo_sfn/types/task_scheduled_event_details.py
class TaskScheduledEventDetails(TypedDict, closed=True):
    resource_type: "capo_sfn.types.name.Name"
    """<p>The service name of the resource in a task state.</p>"""
    resource: "capo_sfn.types.name.Name"
    """<p>The action of the resource called by a task state.</p>"""
    region: "capo_sfn.types.name.Name"
    """<p>The region of the scheduled task</p>"""
    parameters: "capo_sfn.types.connector_parameters.ConnectorParameters"
    """<p>The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>"""
    timeout_in_seconds: NotRequired[
        "capo_sfn.types.timeout_in_seconds.TimeoutInSeconds"
    ]
    """<p>The maximum allowed duration of the task.</p>"""
    heartbeat_in_seconds: NotRequired[
        "capo_sfn.types.timeout_in_seconds.TimeoutInSeconds"
    ]
    """<p>The maximum allowed duration between two heartbeats for the task.</p>"""
    task_credentials: NotRequired["capo_sfn.types.task_credentials.TaskCredentials"]
    """<p>The credentials that Step Functions uses for the task.</p>"""

heartbeat_in_seconds instance-attribute

heartbeat_in_seconds: NotRequired[TimeoutInSeconds]

The maximum allowed duration between two heartbeats for the task.

parameters instance-attribute

parameters: ConnectorParameters

The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

region instance-attribute

region: Name

The region of the scheduled task

resource instance-attribute

resource: Name

The action of the resource called by a task state.

resource_type instance-attribute

resource_type: Name

The service name of the resource in a task state.

task_credentials instance-attribute

task_credentials: NotRequired[TaskCredentials]

The credentials that Step Functions uses for the task.

timeout_in_seconds instance-attribute

timeout_in_seconds: NotRequired[TimeoutInSeconds]

The maximum allowed duration of the task.