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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the user metadata and attributes from the UserId in an identity store.

Synopsis

data DescribeUser = DescribeUser' {
- identityStoreId :: Text
- userId :: Text
}
newDescribeUser :: Text -> Text -> DescribeUser
describeUser_identityStoreId :: Lens' DescribeUser Text
describeUser_userId :: Lens' DescribeUser Text
data DescribeUserResponse = DescribeUserResponse' {
- addresses :: Maybe (NonEmpty Address)
- displayName :: Maybe (Sensitive Text)
- emails :: Maybe (NonEmpty Email)
- externalIds :: Maybe (NonEmpty ExternalId)
- locale :: Maybe (Sensitive Text)
- name :: Maybe Name
- nickName :: Maybe (Sensitive Text)
- phoneNumbers :: Maybe (NonEmpty PhoneNumber)
- preferredLanguage :: Maybe (Sensitive Text)
- profileUrl :: Maybe (Sensitive Text)
- timezone :: Maybe (Sensitive Text)
- title :: Maybe (Sensitive Text)
- userName :: Maybe (Sensitive Text)
- userType :: Maybe (Sensitive Text)
- httpStatus :: Int
- userId :: Text
- identityStoreId :: Text
}
newDescribeUserResponse :: Int -> Text -> Text -> DescribeUserResponse
describeUserResponse_addresses :: Lens' DescribeUserResponse (Maybe (NonEmpty Address))
describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_emails :: Lens' DescribeUserResponse (Maybe (NonEmpty Email))
describeUserResponse_externalIds :: Lens' DescribeUserResponse (Maybe (NonEmpty ExternalId))
describeUserResponse_locale :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Name)
describeUserResponse_nickName :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_phoneNumbers :: Lens' DescribeUserResponse (Maybe (NonEmpty PhoneNumber))
describeUserResponse_preferredLanguage :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_profileUrl :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_timezone :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_title :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_userName :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_userType :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
describeUserResponse_userId :: Lens' DescribeUserResponse Text
describeUserResponse_identityStoreId :: Lens' DescribeUserResponse Text

Creating a Request

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser'
Fields identityStoreId :: Text The globally unique identifier for the identity store, such as `d-1234567890`. In this example, `d-` is a fixed prefix, and `1234567890` is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created. userId :: Text The identifier for a user in the identity store.

Instances

Instances details

ToJSON DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods toJSON :: DescribeUser -> Value # toEncoding :: DescribeUser -> Encoding # toJSONList :: [DescribeUser] -> Value # toEncodingList :: [DescribeUser] -> Encoding #
ToHeaders DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods toHeaders :: DescribeUser -> [Header] #
ToPath DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods toPath :: DescribeUser -> ByteString #
ToQuery DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods toQuery :: DescribeUser -> QueryString #
AWSRequest DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Associated Types type AWSResponse DescribeUser # Methods request :: (Service -> Service) -> DescribeUser -> Request DescribeUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUser))) #
Generic DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Associated Types type Rep DescribeUser :: Type -> Type # Methods from :: DescribeUser -> Rep DescribeUser x # to :: Rep DescribeUser x -> DescribeUser #
Read DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUser # readList :: ReadS [DescribeUser] # readPrec :: ReadPrec DescribeUser # readListPrec :: ReadPrec [DescribeUser] #
Show DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods showsPrec :: Int -> DescribeUser -> ShowS # show :: DescribeUser -> String # showList :: [DescribeUser] -> ShowS #
NFData DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods rnf :: DescribeUser -> () #
Eq DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods (==) :: DescribeUser -> DescribeUser -> Bool # (/=) :: DescribeUser -> DescribeUser -> Bool #
Hashable DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods hashWithSalt :: Int -> DescribeUser -> Int # hash :: DescribeUser -> Int #
type AWSResponse DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser type AWSResponse DescribeUser = DescribeUserResponse
type Rep DescribeUser Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.IdentityStore.DescribeUser" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUser Source #

Arguments

:: Text	`DescribeUser`
-> Text	`DescribeUser`
-> DescribeUser

Create a value of DescribeUser 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:

DescribeUser, describeUser_identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

DescribeUser, describeUser_userId - The identifier for a user in the identity store.

Request Lenses

describeUser_identityStoreId :: Lens' DescribeUser Text Source #

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

describeUser_userId :: Lens' DescribeUser Text Source #

The identifier for a user in the identity store.

Destructuring the Response

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse'

Fields

addresses :: Maybe (NonEmpty Address)
The user's physical address.
displayName :: Maybe (Sensitive Text)
The user's name value for display.
emails :: Maybe (NonEmpty Email)
The user's email value.
externalIds :: Maybe (NonEmpty ExternalId)
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
locale :: Maybe (Sensitive Text)
A string containing the user's geographical region or location.
name :: Maybe Name
The name of the user.
nickName :: Maybe (Sensitive Text)
An alternative descriptive name for the user.
phoneNumbers :: Maybe (NonEmpty PhoneNumber)
A list of PhoneNumber objects associated with a user.
preferredLanguage :: Maybe (Sensitive Text)
The preferred language of the user.
profileUrl :: Maybe (Sensitive Text)
A URL link for the user's profile.
timezone :: Maybe (Sensitive Text)
The time zone for a user.
title :: Maybe (Sensitive Text)
A string containing the user's title.
userName :: Maybe (Sensitive Text)
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
userType :: Maybe (Sensitive Text)
A string indicating the user's type.
httpStatus :: Int
The response's http status code.
userId :: Text
The identifier for a user in the identity store.
identityStoreId :: Text
The globally unique identifier for the identity store.

Instances

Instances details

Generic DescribeUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Associated Types type Rep DescribeUserResponse :: Type -> Type # Methods from :: DescribeUserResponse -> Rep DescribeUserResponse x # to :: Rep DescribeUserResponse x -> DescribeUserResponse #
Show DescribeUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods showsPrec :: Int -> DescribeUserResponse -> ShowS # show :: DescribeUserResponse -> String # showList :: [DescribeUserResponse] -> ShowS #
NFData DescribeUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods rnf :: DescribeUserResponse -> () #
Eq DescribeUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser Methods (==) :: DescribeUserResponse -> DescribeUserResponse -> Bool # (/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool #
type Rep DescribeUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.DescribeUser type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.IdentityStore.DescribeUser" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Address))) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "emails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Email))) :: S1 ('MetaSel ('Just "externalIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExternalId))))) :: ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Name))) :: (S1 ('MetaSel ('Just "nickName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "phoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty PhoneNumber)))))) :: (((S1 ('MetaSel ('Just "preferredLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "profileUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribeUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserResponse'`
-> Text	`DescribeUser`
-> Text	`DescribeUser`
-> DescribeUserResponse

Create a value of DescribeUserResponse 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:

DescribeUserResponse, describeUserResponse_addresses - The user's physical address.

DescribeUserResponse, describeUserResponse_displayName - The user's name value for display.

DescribeUserResponse, describeUserResponse_emails - The user's email value.

DescribeUserResponse, describeUserResponse_externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

DescribeUserResponse, describeUserResponse_locale - A string containing the user's geographical region or location.

DescribeUserResponse, describeUserResponse_name - The name of the user.

DescribeUserResponse, describeUserResponse_nickName - An alternative descriptive name for the user.

DescribeUserResponse, describeUserResponse_phoneNumbers - A list of PhoneNumber objects associated with a user.

DescribeUserResponse, describeUserResponse_preferredLanguage - The preferred language of the user.

DescribeUserResponse, describeUserResponse_profileUrl - A URL link for the user's profile.

DescribeUserResponse, describeUserResponse_timezone - The time zone for a user.

DescribeUserResponse, describeUserResponse_title - A string containing the user's title.

DescribeUserResponse, describeUserResponse_userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

DescribeUserResponse, describeUserResponse_userType - A string indicating the user's type.

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

DescribeUser, describeUserResponse_userId - The identifier for a user in the identity store.

DescribeUser, describeUserResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

describeUserResponse_addresses :: Lens' DescribeUserResponse (Maybe (NonEmpty Address)) Source #

The user's physical address.

describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text) Source #

The user's name value for display.

describeUserResponse_emails :: Lens' DescribeUserResponse (Maybe (NonEmpty Email)) Source #

The user's email value.

describeUserResponse_externalIds :: Lens' DescribeUserResponse (Maybe (NonEmpty ExternalId)) Source #

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

describeUserResponse_locale :: Lens' DescribeUserResponse (Maybe Text) Source #

A string containing the user's geographical region or location.

describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Name) Source #

The name of the user.

describeUserResponse_nickName :: Lens' DescribeUserResponse (Maybe Text) Source #

An alternative descriptive name for the user.

describeUserResponse_phoneNumbers :: Lens' DescribeUserResponse (Maybe (NonEmpty PhoneNumber)) Source #

A list of PhoneNumber objects associated with a user.

describeUserResponse_preferredLanguage :: Lens' DescribeUserResponse (Maybe Text) Source #

The preferred language of the user.

describeUserResponse_profileUrl :: Lens' DescribeUserResponse (Maybe Text) Source #

A URL link for the user's profile.

describeUserResponse_timezone :: Lens' DescribeUserResponse (Maybe Text) Source #

The time zone for a user.

describeUserResponse_title :: Lens' DescribeUserResponse (Maybe Text) Source #

A string containing the user's title.

describeUserResponse_userName :: Lens' DescribeUserResponse (Maybe Text) Source #

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

describeUserResponse_userType :: Lens' DescribeUserResponse (Maybe Text) Source #

A string indicating the user's type.

describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #

The response's http status code.

describeUserResponse_userId :: Lens' DescribeUserResponse Text Source #

The identifier for a user in the identity store.

describeUserResponse_identityStoreId :: Lens' DescribeUserResponse Text Source #

The globally unique identifier for the identity store.