SWF / Client / count_pending_activity_tasks

count_pending_activity_tasks#

SWF.Client.count_pending_activity_tasks(**kwargs)#

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn’t guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

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.count_pending_activity_tasks(
    domain='string',
    taskList={
        'name': 'string'
    }
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The name of the domain that contains the task list.

  • taskList (dict) –

    [REQUIRED]

    The name of the task list.

    • name (string) – [REQUIRED]

      The name of the task list.

Return type:

dict

Returns:

Response Syntax

{
    'count': 123,
    'truncated': True|False
}

Response Structure

  • (dict) –

    Contains the count of tasks in a task list.

    • count (integer) –

      The number of tasks in the task list.

    • truncated (boolean) –

      If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Exceptions

  • SWF.Client.exceptions.UnknownResourceFault

  • SWF.Client.exceptions.OperationNotPermittedFault