QBusiness / Client / get_user

get_user#

QBusiness.Client.get_user(**kwargs)#

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Request Syntax

response = client.get_user(
    applicationId='string',
    userId='string'
)

Parameters:

applicationId (string) –
[REQUIRED]

The identifier of the application connected to the user.
userId (string) –
[REQUIRED]

The user email address attached to the user.

Return type:

dict

Returns:

Response Syntax

{
    'userAliases': [
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ]
}

Response Structure

(dict) –
- userAliases (list) –
  
  A list of user aliases attached to a user.
  - (dict) –
    
    Aliases attached to a user id within an Amazon Q Business application.
    - indexId (string) –
      
      The identifier of the index that the user aliases are associated with.
    - dataSourceId (string) –
      
      The identifier of the data source that the user aliases are associated with.
    - userId (string) –
      
      The identifier of the user id associated with the user aliases.

Exceptions

QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ConflictException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException