libZSservicesZSamazonka-appstreamZSamazonka-appstream
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppStream.CreateUser

Description

Creates a new user in the user pool.

Synopsis

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser' 

Fields

  • 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.

  • firstName :: Maybe (Sensitive Text)

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

  • 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
Eq CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Show CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Generic CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type #

NFData CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Methods

rnf :: CreateUser -> () #

Hashable CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

ToJSON CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

AWSRequest CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Associated Types

type AWSResponse CreateUser #

ToHeaders CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Methods

toHeaders :: CreateUser -> [Header] #

ToPath CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

ToQuery CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

type Rep CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.AppStream.CreateUser" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "messageAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageAction))) :*: (S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType)))))
type AWSResponse CreateUser Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

newCreateUser Source #

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:

$sel:lastName: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.

$sel:firstName:CreateUser', createUser_firstName - The first name, or given name, of the user.

$sel:userName: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.

$sel:authenticationType:CreateUser', createUser_authenticationType - The authentication type for the user. You must specify USERPOOL.

Request Lenses

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_firstName :: Lens' CreateUser (Maybe Text) Source #

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

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

Instances

Instances details
Eq CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Read CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Show CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Generic CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Associated Types

type Rep CreateUserResponse :: Type -> Type #

NFData CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

Methods

rnf :: CreateUserResponse -> () #

type Rep CreateUserResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateUser

type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.AppStream.CreateUser" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserResponse Source #

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