Skip to content

Qbusiness  >  Operations  >  create_user

create_user

Operation

create_user async

create_user(input: CreateUserInput, plugins: list[Plugin] | None = None) -> CreateUserOutput

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

Parameters:

Name Type Description Default
input CreateUserInput

An instance of CreateUserInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateUserOutput

An instance of CreateUserOutput.

Input

CreateUserInput dataclass

Dataclass for CreateUserInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = None

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

client_token class-attribute instance-attribute
client_token: str | None = None

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

user_aliases class-attribute instance-attribute
user_aliases: list[UserAlias] | None = None

The list of user aliases in the mapping.

user_id class-attribute instance-attribute
user_id: str | None = None

The user emails attached to a user mapping.

Output

CreateUserOutput dataclass

Dataclass for CreateUserOutput structure.