QBusiness / Client / create_user

create_user

QBusiness.Client.create_user(**kwargs)

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    applicationId='string',
    clientToken='string',
    userAliases=[
        {
            'dataSourceId': 'string',
            'indexId': 'string',
            'userId': 'string'
        },
    ],
    userId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the application for which the user mapping will be created.

• clientToken (string) –

  A token that you provide to identify the request to create your Amazon Q Business user mapping.

  This field is autopopulated if not provided.

• userAliases (list) –

  The list of user aliases in the mapping.

  • (dict) –

    Aliases attached to a user id within an Amazon Q Business application.

    • dataSourceId (string) –

      The identifier of the data source that the user aliases are associated with.

    • indexId (string) –

      The identifier of the index that the user aliases are associated with.

    • userId (string) – [REQUIRED]

      The identifier of the user id associated with the user aliases.

• userId (string) –

  [REQUIRED]

  The user emails attached to a user mapping.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

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

• QBusiness.Client.exceptions.ServiceQuotaExceededException