Users - Amazon MQ
URIHTTP methodsSchemasProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Users

Note

Does not apply to RabbitMQ brokers.

This is a collection of ActiveMQ users for the specified broker. An ActiveMQ user is a person or an application that can access the queues and topics of an ActiveMQ broker. For more information, see User in the Amazon MQ Developer Guide.

You can configure to have specific permissions. For example, you can allow some users to access the ActiveMQ Web Console.

A user can belong to a group. You can configure which users belong to which groups and which groups have permission to send to, receive from, and administer specific queues and topics.

Important

Making changes to a user does not apply the changes to the user immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker.

URI

/v1/brokers/broker-id/users

HTTP methods

GET

Operation ID: ListUsers

Returns a list of all ActiveMQ users.

Path parameters
NameTypeRequiredDescription
broker-idStringTrue

The unique ID that Amazon MQ generates for the broker.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

maxResultsStringFalse

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

Responses
Status codeResponse modelDescription
200 ListUsersOutput

HTTP Status Code 200: OK.

400Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Response bodies

{
  "brokerId": "string",
  "nextToken": "string",
  "maxResults": integer,
  "users": [
    {
      "pendingChange": enum,
      "username": "string"
    }
  ]
}
{
  "errorAttribute": "string",
  "message": "string"
}

Properties

ChangeType

The type of change pending for the ActiveMQ user.

  • CREATE

  • UPDATE

  • DELETE

Error

Returns information about an error.

PropertyTypeRequiredDescription
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

ListUsersOutput

Returns a list of all ActiveMQ users.

PropertyTypeRequiredDescription
brokerId

string

True

Required. The unique ID that Amazon MQ generates for the broker.

maxResults

integer

Minimum: 5

Maximum: 100

True

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

nextToken

string

False

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

users

Array of type UserSummary

True

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

UserSummary

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

PropertyTypeRequiredDescription
pendingChange

ChangeType

False

The type of change pending for the broker user.

username

string

True

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.