:doc:`IoT <../../iot>` / Client / list_scheduled_audits

*********************
list_scheduled_audits
*********************



.. py:method:: IoT.Client.list_scheduled_audits(**kwargs)

  

  Lists all of your scheduled audits.

   

  Requires permission to access the `ListScheduledAudits <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

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


  **Request Syntax**
  ::

    response = client.list_scheduled_audits(
        nextToken='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at one time. The default is 25.

    

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

    
    ::

      {
          'scheduledAudits': [
              {
                  'scheduledAuditName': 'string',
                  'scheduledAuditArn': 'string',
                  'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
                  'dayOfMonth': 'string',
                  'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **scheduledAudits** *(list) --* 

        The list of scheduled audits.

        
        

        - *(dict) --* 

          Information about the scheduled audit.

          
          

          - **scheduledAuditName** *(string) --* 

            The name of the scheduled audit.

            
          

          - **scheduledAuditArn** *(string) --* 

            The ARN of the scheduled audit.

            
          

          - **frequency** *(string) --* 

            How often the scheduled audit occurs.

            
          

          - **dayOfMonth** *(string) --* 

            The day of the month on which the scheduled audit is run (if the ``frequency`` is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

            
          

          - **dayOfWeek** *(string) --* 

            The day of the week on which the scheduled audit is run (if the ``frequency`` is "WEEKLY" or "BIWEEKLY").

            
      
    
      

      - **nextToken** *(string) --* 

        A token that can be used to retrieve the next set of results, or ``null`` if there are no additional results.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  