SWF / Client / poll_for_activity_task

poll_for_activity_task#

SWF.Client.poll_for_activity_task(**kwargs)#

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Warning

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.poll_for_activity_task(
    domain='string',
    taskList={
        'name': 'string'
    },
    identity='string'
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The name of the domain that contains the task lists being polled.

  • taskList (dict) –

    [REQUIRED]

    Specifies the task list to poll for activity tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • name (string) – [REQUIRED]

      The name of the task list.

  • identity (string) – Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Return type:

dict

Returns:

Response Syntax

{
    'taskToken': 'string',
    'activityId': 'string',
    'startedEventId': 123,
    'workflowExecution': {
        'workflowId': 'string',
        'runId': 'string'
    },
    'activityType': {
        'name': 'string',
        'version': 'string'
    },
    'input': 'string'
}

Response Structure

  • (dict) –

    Unit of work sent to an activity worker.

    • taskToken (string) –

      The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

    • activityId (string) –

      The unique ID of the task.

    • startedEventId (integer) –

      The ID of the ActivityTaskStarted event recorded in the history.

    • workflowExecution (dict) –

      The workflow execution that started this activity task.

      • workflowId (string) –

        The user defined identifier associated with the workflow execution.

      • runId (string) –

        A system-generated unique identifier for the workflow execution.

    • activityType (dict) –

      The type of this activity task.

      • name (string) –

        The name of this activity.

        Note

        The combination of activity type name and version must be unique within a domain.

      • version (string) –

        The version of this activity.

        Note

        The combination of activity type name and version must be unique with in a domain.

    • input (string) –

      The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

Exceptions

  • SWF.Client.exceptions.UnknownResourceFault

  • SWF.Client.exceptions.OperationNotPermittedFault

  • SWF.Client.exceptions.LimitExceededFault