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.Types.User

Description

 
Synopsis

Documentation

data User Source #

Describes a user in the user pool.

See: newUser smart constructor.

Constructors

User' 

Fields

Instances

Instances details
Eq User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

Methods

(==) :: User -> User -> Bool #

(/=) :: User -> User -> Bool #

Show User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

Methods

showsPrec :: Int -> User -> ShowS #

show :: User -> String #

showList :: [User] -> ShowS #

Generic User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

Associated Types

type Rep User :: Type -> Type #

Methods

from :: User -> Rep User x #

to :: Rep User x -> User #

NFData User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

Methods

rnf :: User -> () #

Hashable User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

Methods

hashWithSalt :: Int -> User -> Int #

hash :: User -> Int #

FromJSON User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

type Rep User Source # 
Instance details

Defined in Amazonka.AppStream.Types.User

newUser Source #

Create a value of User 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:status:User', user_status - The status of the user in the user pool. The status can be one of the following:

  • UNCONFIRMED – The user is created but not confirmed.
  • CONFIRMED – The user is confirmed.
  • ARCHIVED – The user is no longer active.
  • COMPROMISED – The user is disabled because of a potential security threat.
  • UNKNOWN – The user status is not known.

$sel:enabled:User', user_enabled - Specifies whether the user in the user pool is enabled.

$sel:lastName:User', user_lastName - The last name, or surname, of the user.

$sel:arn:User', user_arn - The ARN of the user.

$sel:createdTime:User', user_createdTime - The date and time the user was created in the user pool.

$sel:userName:User', user_userName - The email address of the user.

Users' email addresses are case-sensitive.

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

$sel:authenticationType:User', user_authenticationType - The authentication type for the user.

user_status :: Lens' User (Maybe Text) Source #

The status of the user in the user pool. The status can be one of the following:

  • UNCONFIRMED – The user is created but not confirmed.
  • CONFIRMED – The user is confirmed.
  • ARCHIVED – The user is no longer active.
  • COMPROMISED – The user is disabled because of a potential security threat.
  • UNKNOWN – The user status is not known.

user_enabled :: Lens' User (Maybe Bool) Source #

Specifies whether the user in the user pool is enabled.

user_lastName :: Lens' User (Maybe Text) Source #

The last name, or surname, of the user.

user_arn :: Lens' User (Maybe Text) Source #

The ARN of the user.

user_createdTime :: Lens' User (Maybe UTCTime) Source #

The date and time the user was created in the user pool.

user_userName :: Lens' User (Maybe Text) Source #

The email address of the user.

Users' email addresses are case-sensitive.

user_firstName :: Lens' User (Maybe Text) Source #

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

user_authenticationType :: Lens' User AuthenticationType Source #

The authentication type for the user.