Describe User

mq_describe_user

R Documentation

Returns information about an ActiveMQ user¶

Description¶

Returns information about an ActiveMQ user.

Usage¶

mq_describe_user(BrokerId, Username)

Arguments¶

BrokerId

[required] The unique ID that Amazon MQ generates for the broker.

Username

[required] The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Value¶

A list with the following syntax:

list(
  BrokerId = "string",
  ConsoleAccess = TRUE|FALSE,
  Groups = list(
    "string"
  ),
  Pending = list(
    ConsoleAccess = TRUE|FALSE,
    Groups = list(
      "string"
    ),
    PendingChange = "CREATE"|"UPDATE"|"DELETE"
  ),
  Username = "string",
  ReplicationUser = TRUE|FALSE
)

Request syntax¶

svc$describe_user(
  BrokerId = "string",
  Username = "string"
)