Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

CreateUser

Creates a new user in the user pool.

Request Syntax

{ "AuthenticationType": "string", "FirstName": "string", "LastName": "string", "MessageAction": "string", "UserName": "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.

AuthenticationType

The authentication type for the user. You must specify USERPOOL.

Type: String

Valid Values: API | SAML | USERPOOL

Required: Yes

FirstName

The first name, or given name, of the user.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[A-Za-z0-9_\-\s]+$

Required: No

LastName

The last name, or surname, of the user.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[A-Za-z0-9_\-\s]+$

Required: No

MessageAction

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

Note

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

Type: String

Valid Values: SUPPRESS | RESEND

Required: No

UserName

The email address of the user.

Type: String

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

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: Yes

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.

InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

HTTP Status Code: 400

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

See Also

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