Amazon MQ · JSON Structure

Mq Api Logs Summary Structure

The list of information about logs currently enabled and pending to be deployed for the specified broker.

Type: object Properties: 5 Required: 2
BroadcastingMedia ProcessingMedia

LogsSummary is a JSON Structure definition published by Amazon MQ, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Audit AuditLogGroup General GeneralLogGroup Pending

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-mq/refs/heads/main/json-structure/mq-api-logs-summary-structure.json",
  "name": "LogsSummary",
  "type": "object",
  "description": "The list of information about logs currently enabled and pending to be deployed for the specified broker.",
  "properties": {
    "Audit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "xml": {
            "name": "audit"
          },
          "description": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged."
        }
      ]
    },
    "AuditLogGroup": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "auditLogGroup"
          },
          "description": "The location of the CloudWatch Logs log group where audit logs are sent."
        }
      ]
    },
    "General": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "xml": {
            "name": "general"
          },
          "description": "Enables general logging."
        }
      ]
    },
    "GeneralLogGroup": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "generalLogGroup"
          },
          "description": "The location of the CloudWatch Logs log group where general logs are sent."
        }
      ]
    },
    "Pending": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PendingLogs"
        },
        {
          "xml": {
            "name": "pending"
          },
          "description": "The list of information about logs pending to be deployed for the specified broker."
        }
      ]
    }
  },
  "required": [
    "GeneralLogGroup",
    "General"
  ]
}