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

Description

Synopsis

data User = User' {
- accountId :: Maybe Text
- alexaForBusinessMetadata :: Maybe AlexaForBusinessMetadata
- displayName :: Maybe (Sensitive Text)
- invitedOn :: Maybe ISO8601
- licenseType :: Maybe License
- personalPIN :: Maybe Text
- primaryEmail :: Maybe (Sensitive Text)
- primaryProvisionedNumber :: Maybe (Sensitive Text)
- registeredOn :: Maybe ISO8601
- userInvitationStatus :: Maybe InviteStatus
- userRegistrationStatus :: Maybe RegistrationStatus
- userType :: Maybe UserType
- userId :: Text
}
newUser :: Text -> User
user_accountId :: Lens' User (Maybe Text)
user_alexaForBusinessMetadata :: Lens' User (Maybe AlexaForBusinessMetadata)
user_displayName :: Lens' User (Maybe Text)
user_invitedOn :: Lens' User (Maybe UTCTime)
user_licenseType :: Lens' User (Maybe License)
user_personalPIN :: Lens' User (Maybe Text)
user_primaryEmail :: Lens' User (Maybe Text)
user_primaryProvisionedNumber :: Lens' User (Maybe Text)
user_registeredOn :: Lens' User (Maybe UTCTime)
user_userInvitationStatus :: Lens' User (Maybe InviteStatus)
user_userRegistrationStatus :: Lens' User (Maybe RegistrationStatus)
user_userType :: Lens' User (Maybe UserType)
user_userId :: Lens' User Text

Documentation

data User Source #

The user on the Amazon Chime account.

See: newUser smart constructor.

Constructors

User'

Fields

accountId :: Maybe Text
The Amazon Chime account ID.
alexaForBusinessMetadata :: Maybe AlexaForBusinessMetadata
The Alexa for Business metadata.
displayName :: Maybe (Sensitive Text)
The display name of the user.
invitedOn :: Maybe ISO8601
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
licenseType :: Maybe License
The license type for the user.
personalPIN :: Maybe Text
The user's personal meeting PIN.
primaryEmail :: Maybe (Sensitive Text)
The primary email address of the user.
primaryProvisionedNumber :: Maybe (Sensitive Text)
The primary phone number associated with the user.
registeredOn :: Maybe ISO8601
Date and time when the user is registered, in ISO 8601 format.
userInvitationStatus :: Maybe InviteStatus
The user invite status.
userRegistrationStatus :: Maybe RegistrationStatus
The user registration status.
userType :: Maybe UserType
The user type.
userId :: Text
The user ID.

Instances

Instances details

FromJSON User Source #
Instance details Defined in Amazonka.Chime.Types.User Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
Generic User Source #
Instance details Defined in Amazonka.Chime.Types.User Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
Show User Source #
Instance details Defined in Amazonka.Chime.Types.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
NFData User Source #
Instance details Defined in Amazonka.Chime.Types.User Methods rnf :: User -> () #
Eq User Source #
Instance details Defined in Amazonka.Chime.Types.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Hashable User Source #
Instance details Defined in Amazonka.Chime.Types.User Methods hashWithSalt :: Int -> User -> Int # hash :: User -> Int #
type Rep User Source #
Instance details Defined in Amazonka.Chime.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.Chime.Types.User" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "alexaForBusinessMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlexaForBusinessMetadata)) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "invitedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "licenseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe License)) :: S1 ('MetaSel ('Just "personalPIN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "primaryEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "primaryProvisionedNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "registeredOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "userInvitationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InviteStatus)) :: S1 ('MetaSel ('Just "userRegistrationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationStatus))) :: (S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUser Source #

Arguments

:: Text	`$sel:userId: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:accountId:User', user_accountId - The Amazon Chime account ID.

$sel:alexaForBusinessMetadata:User', user_alexaForBusinessMetadata - The Alexa for Business metadata.

$sel:displayName:User', user_displayName - The display name of the user.

$sel:invitedOn:User', user_invitedOn - Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

$sel:licenseType:User', user_licenseType - The license type for the user.

$sel:personalPIN:User', user_personalPIN - The user's personal meeting PIN.

$sel:primaryEmail:User', user_primaryEmail - The primary email address of the user.

$sel:primaryProvisionedNumber:User', user_primaryProvisionedNumber - The primary phone number associated with the user.

$sel:registeredOn:User', user_registeredOn - Date and time when the user is registered, in ISO 8601 format.

$sel:userInvitationStatus:User', user_userInvitationStatus - The user invite status.

$sel:userRegistrationStatus:User', user_userRegistrationStatus - The user registration status.

$sel:userType:User', user_userType - The user type.

$sel:userId:User', user_userId - The user ID.

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

The Amazon Chime account ID.

user_alexaForBusinessMetadata :: Lens' User (Maybe AlexaForBusinessMetadata) Source #

The Alexa for Business metadata.

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

The display name of the user.

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

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

user_licenseType :: Lens' User (Maybe License) Source #

The license type for the user.

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

The user's personal meeting PIN.

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

The primary email address of the user.

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

The primary phone number associated with the user.

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

Date and time when the user is registered, in ISO 8601 format.

user_userInvitationStatus :: Lens' User (Maybe InviteStatus) Source #

The user invite status.

user_userRegistrationStatus :: Lens' User (Maybe RegistrationStatus) Source #

The user registration status.

user_userType :: Lens' User (Maybe UserType) Source #

The user type.

user_userId :: Lens' User Text Source #

The user ID.