Amazon MQ
REST API Reference

Brokers broker-id Users username

URI

/v1/brokers/broker-id/users/username

HTTP Methods

GET

Operation ID: DescribeUser

Returns information about an ActiveMQ user.

Path Parameters

Name Type Required Description
username String True

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.

broker-id String True

The unique ID that Amazon MQ generates for the broker.

Responses

Status Code Response Model Description
200 DescribeUserOutput

HTTP Status Code 200: OK.

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.

POST

Operation ID: CreateUser

Creates an ActiveMQ user.

Path Parameters

Name Type Required Description
username String True

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.

broker-id String True

The unique ID that Amazon MQ generates for the broker.

Responses

Status Code Response Model Description
200 None

HTTP Status Code 200: OK.

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.

409 Error

HTTP Status Code 409: Conflict. Retrying your request might resolve the issue.

500 Error

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

PUT

Operation ID: UpdateUser

Updates the information for an ActiveMQ user.

Path Parameters

Name Type Required Description
username String True

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.

broker-id String True

The unique ID that Amazon MQ generates for the broker.

Responses

Status Code Response Model Description
200 None

HTTP Status Code 200: OK.

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.

409 Error

HTTP Status Code 409: Conflict. Retrying your request might resolve the issue.

500 Error

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

DELETE

Operation ID: DeleteUser

Deletes an ActiveMQ user.

Path Parameters

Name Type Required Description
username String True

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.

broker-id String True

The unique ID that Amazon MQ generates for the broker.

Responses

Status Code Response Model Description
200 None

HTTP Status Code 200: OK.

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

Request Bodies

Example POST

{ "password": "string", "groups": [ "string" ], "consoleAccess": boolean }

Example PUT

{ "password": "string", "groups": [ "string" ], "consoleAccess": boolean }

Response Bodies

Example DescribeUserOutput

{ "brokerId": "string", "pending": { "pendingChange": enum, "groups": [ "string" ], "consoleAccess": boolean }, "groups": [ "string" ], "consoleAccess": boolean, "username": "string" }

Example Error

{ "errorAttribute": "string", "message": "string" }

Properties

ChangeType

The type of change pending for the ActiveMQ user.

  • CREATE

  • UPDATE

  • DELETE

CreateUserInput

Creates a new ActiveMQ user.

Property Type Required Description
password

string

Format: password

False

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

groups

Array of type string

False

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

consoleAccess

boolean

False

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

DescribeUserOutput

Returns information about an ActiveMQ user.

Property Type Required Description
brokerId

string

False

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

pending

UserPendingChanges

False

The status of the changes pending for the ActiveMQ user.

groups

Array of type string

False

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

consoleAccess

boolean

False

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

username

string

False

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

Returns information about an error.

Property Type Required Description
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

UpdateUserInput

Updates the information for an ActiveMQ user.

Property Type Required Description
password

string

Format: password

False

The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

groups

Array of type string

False

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

consoleAccess

boolean

False

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

UserPendingChanges

Returns information about the status of the changes pending for the ActiveMQ user.

Property Type Required Description
pendingChange

ChangeType

False

Required. The type of change pending for the ActiveMQ user.

groups

Array of type string

False

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

consoleAccess

boolean

False

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeUser

CreateUser

UpdateUser

DeleteUser