MQ / Client / create_user

create_user#

MQ.Client.create_user(**kwargs)#

Creates an ActiveMQ user.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    BrokerId='string',
    ConsoleAccess=True|False,
    Groups=[
        'string',
    ],
    Password='string',
    Username='string',
    ReplicationUser=True|False
)
Parameters:

  • BrokerId (string) –

    [REQUIRED]

    The unique ID that Amazon MQ generates for the broker.

  • ConsoleAccess (boolean) – Enables access to the ActiveMQ Web Console for the ActiveMQ user.

  • Groups (list) –

    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.

    • (string) –

  • Password (string) –

    [REQUIRED]

    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 (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.

  • ReplicationUser (boolean) – Defines if this user is intended for CRDR replication purposes.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    HTTP Status Code 200: OK.

Exceptions

  • MQ.Client.exceptions.NotFoundException

  • MQ.Client.exceptions.BadRequestException

  • MQ.Client.exceptions.InternalServerErrorException

  • MQ.Client.exceptions.ConflictException

  • MQ.Client.exceptions.ForbiddenException