Amazon MQ Mq Users API
The Mq Users API from Amazon MQ — 2 operation(s) for mq users.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-mq:amazon-mq-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AmazonMQ Users API
version: '2017-11-27'
description: Generated from AWS's published Smithy model for AmazonMQ. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://mq.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Users
paths:
/v1/brokers/{BrokerId}/users/{Username}:
post:
operationId: CreateUser
summary: Create User
description: Creates an ActiveMQ user. Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
tags:
- Users
delete:
operationId: DeleteUser
summary: Delete User
description: Deletes an ActiveMQ user.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserRequest'
tags:
- Users
get:
operationId: DescribeUser
summary: Describe User
description: Returns information about an ActiveMQ user.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserRequest'
tags:
- Users
put:
operationId: UpdateUser
summary: Update User
description: Updates the information for an ActiveMQ user.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
tags:
- Users
/v1/brokers/{BrokerId}/users:
get:
operationId: ListUsers
summary: List Users
description: Returns a list of all ActiveMQ users.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersRequest'
tags:
- Users
components:
schemas:
ConflictException:
type: object
properties:
ErrorAttribute:
type: string
description: The attribute which caused the error.
Message:
type: string
description: The explanation of the error.
ResourceShareErrors:
type: array
items:
$ref: '#/components/schemas/ResourceShareError'
description: The list of resource share errors.
DescribeUserResponse:
type: object
properties:
BrokerId:
type: string
description: Required. The unique ID that Amazon MQ generates for the broker.
ConsoleAccess:
type: boolean
description: Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups:
type: array
items:
type: string
description: 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.
Pending:
$ref: '#/components/schemas/UserPendingChanges'
Username:
type: string
description: 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.
ReplicationUser:
type: boolean
description: Describes whether the user is intended for data replication
DescribeUserRequest:
type: object
properties:
BrokerId:
type: string
description: The unique ID that Amazon MQ generates for the broker.
Username:
type: string
description: 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.
required:
- BrokerId
- Username
ListUsersResponse:
type: object
properties:
BrokerId:
type: string
description: Required. The unique ID that Amazon MQ generates for the broker.
MaxResults:
type: integer
description: 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:
type: string
description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Users:
type: array
items:
$ref: '#/components/schemas/UserSummary'
description: Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
DeleteUserRequest:
type: object
properties:
BrokerId:
type: string
description: The unique ID that Amazon MQ generates for the broker.
Username:
type: string
description: 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.
required:
- BrokerId
- Username
DeleteUserResponse:
type: object
properties: {}
BadRequestException:
type: object
properties:
ErrorAttribute:
type: string
description: The attribute which caused the error.
Message:
type: string
description: The explanation of the error.
ResourceShareErrors:
type: array
items:
$ref: '#/components/schemas/ResourceShareError'
description: The list of resource share errors.
CreateUserRequest:
type: object
properties:
BrokerId:
type: string
description: The unique ID that Amazon MQ generates for the broker.
ConsoleAccess:
type: boolean
description: Enables access to the ActiveMQ Web Console for the ActiveMQ user.
Groups:
type: array
items:
type: string
description: 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.
Password:
type: string
description: 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, colons, or equal signs (,:=).
Username:
type: string
description: 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.
ReplicationUser:
type: boolean
description: Defines if this user is intended for CRDR replication purposes.
required:
- BrokerId
- Password
- Username
UserPendingChanges:
type: object
properties:
ConsoleAccess:
type: boolean
description: Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups:
type: array
items:
type: string
description: 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.
PendingChange:
type: string
enum:
- CREATE
- UPDATE
- DELETE
description: Required. The type of change pending for the ActiveMQ user.
required:
- PendingChange
UserSummary:
type: object
properties:
PendingChange:
type: string
enum:
- CREATE
- UPDATE
- DELETE
description: The type of change pending for the broker user.
Username:
type: string
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
InternalServerErrorException:
type: object
properties:
ErrorAttribute:
type: string
description: The attribute which caused the error.
Message:
type: string
description: The explanation of the error.
ResourceShareErrors:
type: array
items:
$ref: '#/components/schemas/ResourceShareError'
description: The list of resource share errors.
ListUsersRequest:
type: object
properties:
BrokerId:
type: string
description: The unique ID that Amazon MQ generates for the broker.
MaxResults:
type: integer
description: 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.
NextToken:
type: string
description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
required:
- BrokerId
ForbiddenException:
type: object
properties:
ErrorAttribute:
type: string
description: The attribute which caused the error.
Message:
type: string
description: The explanation of the error.
ResourceShareErrors:
type: array
items:
$ref: '#/components/schemas/ResourceShareError'
description: The list of resource share errors.
ResourceShareError:
type: object
properties:
ErrorCode:
type: string
description: The error code of the resource share.
ResourceShareArn:
type: string
description: The ARN of the resource share.
Status:
type: string
description: The status of the resource share.
NotFoundException:
type: object
properties:
ErrorAttribute:
type: string
description: The attribute which caused the error.
Message:
type: string
description: The explanation of the error.
ResourceShareErrors:
type: array
items:
$ref: '#/components/schemas/ResourceShareError'
description: The list of resource share errors.
UpdateUserResponse:
type: object
properties: {}
CreateUserResponse:
type: object
properties: {}
UpdateUserRequest:
type: object
properties:
BrokerId:
type: string
description: The unique ID that Amazon MQ generates for the broker.
ConsoleAccess:
type: boolean
description: Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups:
type: array
items:
type: string
description: 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.
Password:
type: string
description: 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, colons, or equal signs (,:=).
Username:
type: string
description: 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.
ReplicationUser:
type: boolean
description: Defines whether the user is intended for data replication.
required:
- BrokerId
- Username
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: mq
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/mq/service/2017-11-27/mq-2017-11-27.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)