IoTAnalytics / Client / put_logging_options

put_logging_options#

IoTAnalytics.Client.put_logging_options(**kwargs)#

Sets or updates the IoT Analytics logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

See also: AWS API Documentation

Request Syntax

response = client.put_logging_options(
    loggingOptions={
        'roleArn': 'string',
        'level': 'ERROR',
        'enabled': True|False
    }
)
Parameters:

loggingOptions (dict) –

[REQUIRED]

The new values of the IoT Analytics logging options.

  • roleArn (string) – [REQUIRED]

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

  • level (string) – [REQUIRED]

    The logging level. Currently, only ERROR is supported.

  • enabled (boolean) – [REQUIRED]

    If true, logging is enabled for IoT Analytics.

Returns:

None

Exceptions

  • IoTAnalytics.Client.exceptions.InvalidRequestException

  • IoTAnalytics.Client.exceptions.InternalFailureException

  • IoTAnalytics.Client.exceptions.ServiceUnavailableException

  • IoTAnalytics.Client.exceptions.ThrottlingException