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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Describes a user in the user pool and the associated stack.



The authentication type for the user.

Type: String

Valid Values: API | SAML | USERPOOL

Required: Yes


Specifies whether a welcome email is sent to a user after the user is created in the user pool.

Type: Boolean

Required: No


The name of the stack that is associated with the user.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes


The email address of the user who is associated with the stack.


Users' email addresses are case-sensitive.

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

See Also

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

On this page: