create_user¶
Operation¶
create_user
¶
create_user(request: CreateUserInput | CreateUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateUserInputDict]) -> CreateUserOutput
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateUserInput | CreateUserInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateUserOutput
|
An instance of |
create_user
async
¶
create_user(request: CreateUserInput | CreateUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateUserInputDict]) -> CreateUserOutput
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateUserInput | CreateUserInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateUserOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateUserInputDict
¶
Bases: TypedDict
Dictionary form of CreateUserInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the application for which the user mapping will be created.
client_token
instance-attribute
¶
client_token: str | None
A token that you provide to identify the request to create your Amazon Q Business user mapping.
This field is autopopulated if not provided.
user_aliases
instance-attribute
¶
user_aliases: Sequence[UserAlias | UserAliasDict] | None
The list of user aliases in the mapping.
CreateUserInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateUserInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the application for which the user mapping will be created.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A token that you provide to identify the request to create your Amazon Q Business user mapping.
This field is autopopulated if not provided.
user_aliases
class-attribute
instance-attribute
¶
The list of user aliases in the mapping.
Output¶
CreateUserOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateUserOutput structure.