describe_logging_options

IoTAnalytics.Client.describe_logging_options()

Retrieves the current settings of the IoT Analytics logging options.

See also: AWS API Documentation

Request Syntax

response = client.describe_logging_options()
Return type
dict
Returns
Response Syntax
{
    'loggingOptions': {
        'roleArn': 'string',
        'level': 'ERROR',
        'enabled': True|False
    }
}

Response Structure

  • (dict) --
    • loggingOptions (dict) --

      The current settings of the IoT Analytics logging options.

      • roleArn (string) --

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

      • level (string) --

        The logging level. Currently, only ERROR is supported.

      • enabled (boolean) --

        If true, logging is enabled for IoT Analytics.

Exceptions

  • IoTAnalytics.Client.exceptions.InvalidRequestException
  • IoTAnalytics.Client.exceptions.ResourceNotFoundException
  • IoTAnalytics.Client.exceptions.InternalFailureException
  • IoTAnalytics.Client.exceptions.ServiceUnavailableException
  • IoTAnalytics.Client.exceptions.ThrottlingException