Amazonka.AppStream.Types.User

Documentation

data User

Describes a user in the user pool.

See: newUser smart constructor.

Constructors

User'

Fields

• arn :: Maybe Text

  The ARN of the user.

• createdTime :: Maybe POSIX

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

• enabled :: Maybe Bool

  Specifies whether the user in the user pool is enabled.

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

• status :: Maybe Text

  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.
• userName :: Maybe (Sensitive Text)

  The email address of the user.

  Users' email addresses are case-sensitive.

• authenticationType :: AuthenticationType

  The authentication type for the user.

Instances

FromJSON User

Defined in Amazonka.AppStream.Types.User

Methods

parseJSON :: Value -> Parser User

parseJSONList :: Value -> Parser [User]

Generic User

Defined in Amazonka.AppStream.Types.User

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

Show User

Defined in Amazonka.AppStream.Types.User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

NFData User

Defined in Amazonka.AppStream.Types.User

Methods

rnf :: User -> ()

Eq User

Defined in Amazonka.AppStream.Types.User

Methods

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

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

Hashable User

Defined in Amazonka.AppStream.Types.User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

type Rep User

Defined in Amazonka.AppStream.Types.User

type Rep User = D1 ('MetaData "User" "Amazonka.AppStream.Types.User" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType)))))

newUser

Arguments

:: AuthenticationType

$sel:authenticationType:User'

-> User

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: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:enabled:User', user_enabled - Specifies whether the user in the user pool is enabled.

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

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

$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:userName:User', user_userName - The email address of the user.

Users' email addresses are case-sensitive.

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

user_arn :: Lens' User (Maybe Text)

The ARN of the user.

user_createdTime :: Lens' User (Maybe UTCTime)

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

user_enabled :: Lens' User (Maybe Bool)

Specifies whether the user in the user pool is enabled.

user_firstName :: Lens' User (Maybe Text)

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

user_lastName :: Lens' User (Maybe Text)

The last name, or surname, of the user.

user_status :: Lens' User (Maybe Text)

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_userName :: Lens' User (Maybe Text)

The email address of the user.

Users' email addresses are case-sensitive.

user_authenticationType :: Lens' User AuthenticationType

The authentication type for the user.