Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppStream.CreateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new user in the user pool.

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

firstName :: Maybe (Sensitive Text)
The first name, or given name, of the user.
lastName :: Maybe (Sensitive Text)
The last name, or surname, of the user.
messageAction :: Maybe 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.
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.
userName :: Sensitive Text
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
authenticationType :: AuthenticationType
The authentication type for the user. You must specify USERPOOL.

Instances

Instances details

ToJSON CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods toQuery :: CreateUser -> QueryString #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: (Service -> Service) -> CreateUser -> Request CreateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
Generic CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
Show CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
NFData CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods rnf :: CreateUser -> () #
Eq CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Hashable CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser type AWSResponse CreateUser = CreateUserResponse
type Rep CreateUser Source #
Instance details Defined in Amazonka.AppStream.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.AppStream.CreateUser" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "messageAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageAction)) :: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType)))))

newCreateUser Source #

Arguments

:: Text	`CreateUser`
-> AuthenticationType	`CreateUser`
-> CreateUser

Create a value of CreateUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateUser, createUser_firstName - The first name, or given name, of the user.

CreateUser, createUser_lastName - The last name, or surname, of the user.

$sel:messageAction:CreateUser', createUser_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.

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.

CreateUser, createUser_userName - The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

CreateUser, createUser_authenticationType - The authentication type for the user. You must specify USERPOOL.

Request Lenses

createUser_firstName :: Lens' CreateUser (Maybe Text) Source #

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

createUser_lastName :: Lens' CreateUser (Maybe Text) Source #

The last name, or surname, of the user.

createUser_messageAction :: Lens' CreateUser (Maybe MessageAction) Source #

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.

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.

createUser_userName :: Lens' CreateUser Text Source #

The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

createUser_authenticationType :: Lens' CreateUser AuthenticationType Source #

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

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser Associated Types type Rep CreateUserResponse :: Type -> Type # Methods from :: CreateUserResponse -> Rep CreateUserResponse x # to :: Rep CreateUserResponse x -> CreateUserResponse #
Read CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods rnf :: CreateUserResponse -> () #
Eq CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.AppStream.CreateUser" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> CreateUserResponse

Create a value of CreateUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

Response Lenses

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.