Amazon IoT Events · JSON Structure

Iot Events Logging Options Structure

The values of the AWS IoT Events logging options.

Type: object Properties: 4 Required: 3
Event DetectionIoTState MachineAutomation

LoggingOptions is a JSON Structure definition published by Amazon IoT Events, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

roleArn level enabled detectorDebugOptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/json-structure/iot-events-logging-options-structure.json",
  "name": "LoggingOptions",
  "description": "The values of the AWS IoT Events logging options.",
  "type": "object",
  "properties": {
    "roleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonResourceName"
        },
        {
          "description": "The ARN of the role that grants permission to AWS IoT Events to perform logging."
        }
      ]
    },
    "level": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingLevel"
        },
        {
          "description": "The logging level."
        }
      ]
    },
    "enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingEnabled"
        },
        {
          "description": "If TRUE, logging is enabled for AWS IoT Events."
        }
      ]
    },
    "detectorDebugOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DetectorDebugOptions"
        },
        {
          "description": "Information that identifies those detector models and their detectors (instances) for which the logging level is given."
        }
      ]
    }
  },
  "required": [
    "roleArn",
    "level",
    "enabled"
  ]
}