:doc:`IoTEvents <../../iotevents>` / Client / describe_logging_options

************************
describe_logging_options
************************



.. py:method:: IoTEvents.Client.describe_logging_options()

  

  Retrieves the current settings of the AWS IoT Events logging options.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeLoggingOptions>`_  


  **Request Syntax**
  ::

    response = client.describe_logging_options()
    
    
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'loggingOptions': {
              'roleArn': 'string',
              'level': 'ERROR'|'INFO'|'DEBUG',
              'enabled': True|False,
              'detectorDebugOptions': [
                  {
                      'detectorModelName': 'string',
                      'keyValue': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **loggingOptions** *(dict) --* 

        The current settings of the AWS IoT Events logging options.

        
        

        - **roleArn** *(string) --* 

          The ARN of the role that grants permission to AWS IoT Events to perform logging.

          
        

        - **level** *(string) --* 

          The logging level.

          
        

        - **enabled** *(boolean) --* 

          If TRUE, logging is enabled for AWS IoT Events.

          
        

        - **detectorDebugOptions** *(list) --* 

          Information that identifies those detector models and their detectors (instances) for which the logging level is given.

          
          

          - *(dict) --* 

            The detector model and the specific detectors (instances) for which the logging level is given.

            
            

            - **detectorModelName** *(string) --* 

              The name of the detector model.

              
            

            - **keyValue** *(string) --* 

              The value of the input attribute key used to create the detector (the instance of the detector model).

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

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

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

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

  
  *   :py:class:`IoTEvents.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoTEvents.Client.exceptions.UnsupportedOperationException`

  