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.IdentityStore.Types.Name

Description

Synopsis

data Name = Name' {
- familyName :: Maybe (Sensitive Text)
- formatted :: Maybe (Sensitive Text)
- givenName :: Maybe (Sensitive Text)
- honorificPrefix :: Maybe (Sensitive Text)
- honorificSuffix :: Maybe (Sensitive Text)
- middleName :: Maybe (Sensitive Text)
}
newName :: Name
name_familyName :: Lens' Name (Maybe Text)
name_formatted :: Lens' Name (Maybe Text)
name_givenName :: Lens' Name (Maybe Text)
name_honorificPrefix :: Lens' Name (Maybe Text)
name_honorificSuffix :: Lens' Name (Maybe Text)
name_middleName :: Lens' Name (Maybe Text)

Documentation

data Name Source #

The full name of the user.

See: newName smart constructor.

Constructors

Name'

Fields

familyName :: Maybe (Sensitive Text)
The family name of the user.
formatted :: Maybe (Sensitive Text)
A string containing a formatted version of the name for display.
givenName :: Maybe (Sensitive Text)
The given name of the user.
honorificPrefix :: Maybe (Sensitive Text)
The honorific prefix of the user. For example, "Dr."
honorificSuffix :: Maybe (Sensitive Text)
The honorific suffix of the user. For example, "M.D."
middleName :: Maybe (Sensitive Text)
The middle name of the user.

Instances

Instances details

FromJSON Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods parseJSON :: Value -> Parser Name # parseJSONList :: Value -> Parser [Name] #
ToJSON Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods toJSON :: Name -> Value # toEncoding :: Name -> Encoding # toJSONList :: [Name] -> Value # toEncodingList :: [Name] -> Encoding #
Generic Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Associated Types type Rep Name :: Type -> Type # Methods from :: Name -> Rep Name x # to :: Rep Name x -> Name #
Show Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
NFData Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods rnf :: Name -> () #
Eq Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Hashable Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name Methods hashWithSalt :: Int -> Name -> Int # hash :: Name -> Int #
type Rep Name Source #
Instance details Defined in Amazonka.IdentityStore.Types.Name type Rep Name = D1 ('MetaData "Name" "Amazonka.IdentityStore.Types.Name" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "Name'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "familyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "formatted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "givenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "honorificPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "honorificSuffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "middleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))))

newName :: Name Source #

Create a value of Name 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:familyName:Name', name_familyName - The family name of the user.

$sel:formatted:Name', name_formatted - A string containing a formatted version of the name for display.

$sel:givenName:Name', name_givenName - The given name of the user.

$sel:honorificPrefix:Name', name_honorificPrefix - The honorific prefix of the user. For example, "Dr."

$sel:honorificSuffix:Name', name_honorificSuffix - The honorific suffix of the user. For example, "M.D."

$sel:middleName:Name', name_middleName - The middle name of the user.

name_familyName :: Lens' Name (Maybe Text) Source #

The family name of the user.

name_formatted :: Lens' Name (Maybe Text) Source #

A string containing a formatted version of the name for display.

name_givenName :: Lens' Name (Maybe Text) Source #

The given name of the user.

name_honorificPrefix :: Lens' Name (Maybe Text) Source #

The honorific prefix of the user. For example, "Dr."

name_honorificSuffix :: Lens' Name (Maybe Text) Source #

The honorific suffix of the user. For example, "M.D."

name_middleName :: Lens' Name (Maybe Text) Source #

The middle name of the user.