Amazon MQ · JSON Structure

Mq Api User Summary Structure

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

Type: object Properties: 2 Required: 1
BroadcastingMedia ProcessingMedia

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

Properties

PendingChange Username

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-user-summary-structure.json",
  "name": "UserSummary",
  "type": "object",
  "description": "Returns a list of all broker users. Does not apply to RabbitMQ brokers.",
  "properties": {
    "PendingChange": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeType"
        },
        {
          "xml": {
            "name": "pendingChange"
          },
          "description": "The type of change pending for the broker user."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "username"
          },
          "description": "Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
        }
      ]
    }
  },
  "required": [
    "Username"
  ]
}