IoTSiteWise / Client / list_tasks

list_tasks

IoTSiteWise.Client.list_tasks(**kwargs)

Lists tasks in a workspace. To get complete details about a task, use DescribeTask.

See also: AWS API Documentation

Request Syntax

response = client.list_tasks(
    workspaceName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) – The maximum number of results to return for each paginated request. Default: 50.

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) –

      The token to be used for the next set of paginated results.

Exceptions