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

************************
describe_scheduled_audit
************************



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

  

  Gets information about a scheduled audit.

   

  Requires permission to access the `DescribeScheduledAudit <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/DescribeScheduledAudit>`_  


  **Request Syntax**
  ::

    response = client.describe_scheduled_audit(
        scheduledAuditName='string'
    )
    
  :type scheduledAuditName: string
  :param scheduledAuditName: **[REQUIRED]** 

    The name of the scheduled audit whose information you want to get.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        How often the scheduled audit takes place, either one of ``DAILY``, ``WEEKLY``, ``BIWEEKLY``, or ``MONTHLY``. The start time of each audit is determined by the system.

        
      

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

        The day of the month on which the scheduled audit takes place. This is will be ``1`` through ``31`` or ``LAST``. 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 takes place, either one of ``SUN``, ``MON``, ``TUE``, ``WED``, ``THU``, ``FRI``, or ``SAT``.

        
      

      - **targetCheckNames** *(list) --* 

        Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use ``DescribeAccountAuditConfiguration`` to see the list of all checks, including those that are enabled or use ``UpdateAccountAuditConfiguration`` to select which checks are enabled.)

        
        

        - *(string) --* 

          An audit check name. Checks must be enabled for your account. (Use ``DescribeAccountAuditConfiguration`` to see the list of all checks, including those that are enabled or use ``UpdateAccountAuditConfiguration`` to select which checks are enabled.)

          
    
      

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

        The name of the scheduled audit.

        
      

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

        The ARN of the scheduled audit.

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

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

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

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

  