MQ / Client / describe_user

describe_user#

MQ.Client.describe_user(**kwargs)#

Returns information about an ActiveMQ user.

Request Syntax

response = client.describe_user(
    BrokerId='string',
    Username='string'
)

Parameters:

BrokerId (string) –
[REQUIRED]

The unique ID that Amazon MQ generates for the broker.
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.

Return type:

dict

Returns:

Response Syntax

{
    'BrokerId': 'string',
    'ConsoleAccess': True|False,
    'Groups': [
        'string',
    ],
    'Pending': {
        'ConsoleAccess': True|False,
        'Groups': [
            'string',
        ],
        'PendingChange': 'CREATE'|'UPDATE'|'DELETE'
    },
    'Username': 'string'
}

Response Structure

(dict) –

HTTP Status Code 200: OK.
- 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) –
- Pending (dict) –
  
  The status of the changes pending for the ActiveMQ user.
  - 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) –
  - PendingChange (string) –
    
    Required. The type of change pending for the ActiveMQ user.
- 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.

Exceptions

MQ.Client.exceptions.NotFoundException
MQ.Client.exceptions.BadRequestException
MQ.Client.exceptions.InternalServerErrorException
MQ.Client.exceptions.ForbiddenException