Amazon MQ
REST API Reference

Users

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

Returns a list of all ActiveMQ users.

Path

Name Type Description

broker-id

string

The unique ID that Amazon MQ generates for the broker.

Query

Name Type Description

maxResults

integer

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

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

Response

Status Code Schema Description

200

ListUsersOutput

HTTP Status Code 200: OK.

Errors

Errors

Status Code Schema Description

400

Error

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

403

Error

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

404

Error

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

500

Error

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

Schemas

Response Schemas

Example ListUsersOutput

{ "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "users": [{ "username": "jane.doe", "pendingChange": "CREATE" }, { "username": "paolo.santos" }], "maxResults": 20, "nextToken": "eyEXAMPLEW9uIjoidjEiLCJzZXJpYWxpemVkUGFnaW5hdGlvblRva2VuIjoiZXlKMGIydGxia1JoZEdFaU9uc2liR0Z6ZEMxelpXVnVMV0p5YjJ0bGNpMWhjbTRpT2lJeEluMTkifQ==" }

Example Error

{ "errorAttribute": "TheAttributeWhichCausedTheError", "message": "This is the description of the error and the steps to resolve the issue." }

Attributes

ListUsersOutput

Attribute Type Description

brokerId

string

Required

The unique ID that Amazon MQ generates for the broker.

maxResults

integer

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

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

users

array

Required

The list of all ActiveMQ usernames for the specified broker.

UserSummary

Attribute Type Description

pendingChange

enum

The type of change pending for the ActiveMQ user.

Possible values: CREATE, UPDATE, DELETE

username

string

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.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.