CreateUser
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Request Syntax
POST /applications/applicationId
/users HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"userAliases": [
{
"dataSourceId": "string
",
"indexId": "string
",
"userId": "string
"
}
],
"userId": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the application for which the user mapping will be created.
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A token that you provide to identify the request to create your Amazon Q Business user mapping.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- userAliases
-
The list of user aliases in the mapping.
Type: Array of UserAlias objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- userId
-
The user emails attached to a user mapping.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- ConflictException
-
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
HTTP Status Code: 409
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
You have exceeded the set limits for your Amazon Q Business service.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: