IoTEvents / Client / describe_logging_options

describe_logging_options#

IoTEvents.Client.describe_logging_options()#

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

Request Syntax

response = client.describe_logging_options()

Return type:

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

IoTEvents.Client.exceptions.InvalidRequestException
IoTEvents.Client.exceptions.ThrottlingException
IoTEvents.Client.exceptions.InternalFailureException
IoTEvents.Client.exceptions.ResourceNotFoundException
IoTEvents.Client.exceptions.ServiceUnavailableException
IoTEvents.Client.exceptions.UnsupportedOperationException