:doc:`SnowDeviceManagement <../../snow-device-management>` / Paginator / ListTasks

*********
ListTasks
*********



.. py:class:: SnowDeviceManagement.Paginator.ListTasks

  ::

    
    paginator = client.get_paginator('list_tasks')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SnowDeviceManagement.Client.list_tasks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          state='IN_PROGRESS'|'CANCELED'|'COMPLETED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type state: string
    :param state: 

      A structure used to filter the list of tasks.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'tasks': [
                {
                    'state': 'IN_PROGRESS'|'CANCELED'|'COMPLETED',
                    'tags': {
                        'string': 'string'
                    },
                    'taskArn': 'string',
                    'taskId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **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.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    