MQ / Client / update_user

update_user#

MQ.Client.update_user(**kwargs)#

Updates the information for an ActiveMQ user.

See also: AWS API Documentation

Request Syntax

response = client.update_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 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) – 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 whether the user is intended for data replication.

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