Menu
Sign In to the Console
Alexa For Business
Alexa for Business API (API Version 2017-11-09)

AWS Documentation » Alexa for Business » Alexa for Business API » Actions » CreateUser

CreateUser

Creates a user.

Request Syntax

{
   "ClientRequestToken": "string",
   "Email": "string",
   "FirstName": "string",
   "LastName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UserId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

Email

The email address for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})

Required: No

FirstName

The first name for the user.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 30.

Pattern: ([A-Za-z\-' 0-9._]|\p{IsLetter})*

Required: No

LastName

The last name for the user.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 30.

Pattern: ([A-Za-z\-' 0-9._]|\p{IsLetter})*

Required: No

Tags

The tags for the user.

Type: Array of Tag objects

Required: No

UserId

The ARN for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9@_+.-]*

Required: Yes

Response Syntax

{
   "UserArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserArn

The ARN of the newly created user in the response.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Errors

For information about the errors that are common to all actions, see Common Errors.

LimitExceededException

You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

HTTP Status Code: 400

ResourceInUseException

The resource in the request is already in use. HTTP Status Code: 400

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: