Skip to content

ActivityTaskScheduledEventAttributes

Source code in docs_src/capo_swf/types/activity_task_scheduled_event_attributes.py
class ActivityTaskScheduledEventAttributes(TypedDict, closed=True):
    activity_type: "capo_swf.types.activity_type.ActivityType"
    """<p>The type of the activity task.</p>"""
    activity_id: "capo_swf.types.activity_id.ActivityId"
    """<p>The unique ID of the activity task.</p>"""
    input: NotRequired["capo_swf.types.data.Data"]
    """<p>The input provided to the activity task.</p>"""
    control: NotRequired["capo_swf.types.data.Data"]
    """<p>Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.</p>"""
    schedule_to_start_timeout: NotRequired[
        "capo_swf.types.duration_in_seconds_optional.DurationInSecondsOptional"
    ]
    """<p>The maximum amount of time the activity task can wait to be assigned to a worker.</p>"""
    schedule_to_close_timeout: NotRequired[
        "capo_swf.types.duration_in_seconds_optional.DurationInSecondsOptional"
    ]
    """<p>The maximum amount of time for this activity task.</p>"""
    start_to_close_timeout: NotRequired[
        "capo_swf.types.duration_in_seconds_optional.DurationInSecondsOptional"
    ]
    """<p>The maximum amount of time a worker may take to process the activity task.</p>"""
    task_list: "capo_swf.types.task_list.TaskList"
    """<p>The task list in which the activity task has been scheduled.</p>"""
    task_priority: NotRequired["capo_swf.types.task_priority.TaskPriority"]
    """<p> The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.</p> <p>Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>"""
    decision_task_completed_event_id: "capo_swf.types.event_id.EventId"
    """<p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"""
    heartbeat_timeout: NotRequired[
        "capo_swf.types.duration_in_seconds_optional.DurationInSecondsOptional"
    ]
    """<p>The maximum time before which the worker processing this task must report progress by calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.</p>"""

activity_id instance-attribute

activity_id: ActivityId

The unique ID of the activity task.

activity_type instance-attribute

activity_type: ActivityType

The type of the activity task.

control instance-attribute

control: NotRequired[Data]

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

decision_task_completed_event_id instance-attribute

decision_task_completed_event_id: EventId

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

heartbeat_timeout instance-attribute

heartbeat_timeout: NotRequired[DurationInSecondsOptional]

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

input instance-attribute

input: NotRequired[Data]

The input provided to the activity task.

schedule_to_close_timeout instance-attribute

schedule_to_close_timeout: NotRequired[DurationInSecondsOptional]

The maximum amount of time for this activity task.

schedule_to_start_timeout instance-attribute

schedule_to_start_timeout: NotRequired[DurationInSecondsOptional]

The maximum amount of time the activity task can wait to be assigned to a worker.

start_to_close_timeout instance-attribute

start_to_close_timeout: NotRequired[DurationInSecondsOptional]

The maximum amount of time a worker may take to process the activity task.

task_list instance-attribute

task_list: TaskList

The task list in which the activity task has been scheduled.

task_priority instance-attribute

task_priority: NotRequired[TaskPriority]

The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.