IoTEvents / Client / put_logging_options

put_logging_options#

IoTEvents.Client.put_logging_options(**kwargs)#

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. 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.

Request Syntax

response = client.put_logging_options(
    loggingOptions={
        'roleArn': 'string',
        'level': 'ERROR'|'INFO'|'DEBUG',
        'enabled': True|False,
        'detectorDebugOptions': [
            {
                'detectorModelName': 'string',
                'keyValue': 'string'
            },
        ]
    }
)

Parameters:

loggingOptions (dict) –

[REQUIRED]

The new values of the AWS IoT Events logging options.

roleArn (string) – [REQUIRED]

The ARN of the role that grants permission to AWS IoT Events to perform logging.
level (string) – [REQUIRED]

The logging level.
enabled (boolean) – [REQUIRED]

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) – [REQUIRED]
    
    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).

Returns:

None

Exceptions

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