SnowDeviceManagement / Client / list_tasks

list_tasks#

SnowDeviceManagement.Client.list_tasks(**kwargs)#

Returns a list of tasks that can be filtered by state.

Request Syntax

response = client.list_tasks(
    maxResults=123,
    nextToken='string',
    state='IN_PROGRESS'|'CANCELED'|'COMPLETED'
)

Parameters:

maxResults (integer) – The maximum number of tasks per page.
nextToken (string) – A pagination token to continue to the next page of tasks.
state (string) – A structure used to filter the list of tasks.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'tasks': [
        {
            'state': 'IN_PROGRESS'|'CANCELED'|'COMPLETED',
            'tags': {
                'string': 'string'
            },
            'taskArn': 'string',
            'taskId': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A pagination token to continue to the next page of tasks.
- tasks (list) –
  
  A list of task structures containing details about each task.
  - (dict) –
    
    Information about the task assigned to one or many devices.
    - state (string) –
      
      The state of the task assigned to one or many devices.
    - tags (dict) –
      
      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.
      - (string) –
        
        (string) –
    - taskArn (string) –
      
      The Amazon Resource Name (ARN) of the task.
    - taskId (string) –
      
      The task ID.

Exceptions

SnowDeviceManagement.Client.exceptions.ThrottlingException
SnowDeviceManagement.Client.exceptions.InternalServerException
SnowDeviceManagement.Client.exceptions.ValidationException
SnowDeviceManagement.Client.exceptions.AccessDeniedException