:doc:`MQ <../../mq>` / Client / describe_user

*************
describe_user
*************



.. py:method:: MQ.Client.describe_user(**kwargs)

  

  Returns information about an ActiveMQ user.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUser>`_  


  **Request Syntax**
  ::

    response = client.describe_user(
        BrokerId='string',
        Username='string'
    )
    
  :type BrokerId: string
  :param BrokerId: **[REQUIRED]** 

    The unique ID that Amazon MQ generates for the broker.

    

  
  :type Username: string
  :param Username: **[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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'BrokerId': 'string',
          'ConsoleAccess': True|False,
          'Groups': [
              'string',
          ],
          'Pending': {
              'ConsoleAccess': True|False,
              'Groups': [
                  'string',
              ],
              'PendingChange': 'CREATE'|'UPDATE'|'DELETE'
          },
          'Username': 'string',
          'ReplicationUser': True|False
      }
      
    **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.

        
      

      - **ReplicationUser** *(boolean) --* 

        Describes whether the user is intended for data replication

        
  
  **Exceptions**
  
  *   :py:class:`MQ.Client.exceptions.NotFoundException`

  
  *   :py:class:`MQ.Client.exceptions.BadRequestException`

  
  *   :py:class:`MQ.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MQ.Client.exceptions.ForbiddenException`

  