IoTSiteWise / Paginator / ListTasks

ListTasks

class IoTSiteWise.Paginator.ListTasks

paginator = client.get_paginator('list_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workspaceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'taskSummaries': [
        {
            'taskName': 'string',
            'description': 'string',
            'taskArn': 'string',
            'version': 'string',
            'status': {
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string'
                },
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for ListTasks operation.

  • taskSummaries (list) –

    A list that summarizes each task in the workspace.

    • (dict) –

      Contains summary information about a task.

      • taskName (string) –

        The name of the task.

      • description (string) –

        The description of the task.

      • taskArn (string) –

        The ARN of the task.

      • version (string) –

        The version of the task.

      • status (dict) –

        The current lifecycle status of the task.

        • error (dict) –

          Contains associated error information, if any.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

        • state (string) –

          The current status of the resource.

      • createdAt (datetime) –

        The time the task was created, in Unix epoch time.

      • updatedAt (datetime) –

        The time the task was last updated, in Unix epoch time.

  • NextToken (string) –

    A token to resume pagination.