:doc:`IoT <../../iot>` / Paginator / ListAuditTasks

**************
ListAuditTasks
**************



.. py:class:: IoT.Paginator.ListAuditTasks

  ::

    
    paginator = client.get_paginator('list_audit_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_audit_tasks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListAuditTasks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          startTime=datetime(2015, 1, 1),
          endTime=datetime(2015, 1, 1),
          taskType='ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK',
          taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type startTime: datetime
    :param startTime: **[REQUIRED]** 

      The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

      

    
    :type endTime: datetime
    :param endTime: **[REQUIRED]** 

      The end of the time period.

      

    
    :type taskType: string
    :param taskType: 

      A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

      

    
    :type taskStatus: string
    :param taskStatus: 

      A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

      

    
    :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': [
                {
                    'taskId': 'string',
                    'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
                    'taskType': 'ON_DEMAND_AUDIT_TASK'|'SCHEDULED_AUDIT_TASK'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **tasks** *(list) --* 

          The audits that were performed during the specified time period.

          
          

          - *(dict) --* 

            The audits that were performed.

            
            

            - **taskId** *(string) --* 

              The ID of this audit.

              
            

            - **taskStatus** *(string) --* 

              The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

              
            

            - **taskType** *(string) --* 

              The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

              
        
      
        

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

          A token to resume pagination.

          
    