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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the UserId in an identity store.

Creating a Request

data GetUserId Source #

See: newGetUserId smart constructor.

Constructors

GetUserId'
Fields identityStoreId :: Text The globally unique identifier for the identity store. alternateIdentifier :: AlternateIdentifier A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique `UserDisplayName`.

Instances

Instances details

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

newGetUserId Source #

Arguments

:: Text	`GetUserId`
-> AlternateIdentifier	`$sel:alternateIdentifier:GetUserId'`
-> GetUserId

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

GetUserId, getUserId_identityStoreId - The globally unique identifier for the identity store.

$sel:alternateIdentifier:GetUserId', getUserId_alternateIdentifier - A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique UserDisplayName.

Request Lenses

getUserId_identityStoreId :: Lens' GetUserId Text Source #

The globally unique identifier for the identity store.

getUserId_alternateIdentifier :: Lens' GetUserId AlternateIdentifier Source #

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique UserDisplayName.

Destructuring the Response

data GetUserIdResponse Source #

See: newGetUserIdResponse smart constructor.

Constructors

GetUserIdResponse'
Fields 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 GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId Associated Types type Rep GetUserIdResponse :: Type -> Type # Methods from :: GetUserIdResponse -> Rep GetUserIdResponse x # to :: Rep GetUserIdResponse x -> GetUserIdResponse #
Read GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId Methods readsPrec :: Int -> ReadS GetUserIdResponse # readList :: ReadS [GetUserIdResponse] # readPrec :: ReadPrec GetUserIdResponse # readListPrec :: ReadPrec [GetUserIdResponse] #
Show GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId Methods showsPrec :: Int -> GetUserIdResponse -> ShowS # show :: GetUserIdResponse -> String # showList :: [GetUserIdResponse] -> ShowS #
NFData GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId Methods rnf :: GetUserIdResponse -> () #
Eq GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId Methods (==) :: GetUserIdResponse -> GetUserIdResponse -> Bool # (/=) :: GetUserIdResponse -> GetUserIdResponse -> Bool #
type Rep GetUserIdResponse Source #
Instance details Defined in Amazonka.IdentityStore.GetUserId type Rep GetUserIdResponse = D1 ('MetaData "GetUserIdResponse" "Amazonka.IdentityStore.GetUserId" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "GetUserIdResponse'" 'PrefixI 'True) (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))))

newGetUserIdResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUserIdResponse'`
-> Text	`GetUserIdResponse`
-> Text	`GetUserId`
-> GetUserIdResponse

Create a value of GetUserIdResponse 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:httpStatus:GetUserIdResponse', getUserIdResponse_httpStatus - The response's http status code.

GetUserIdResponse, getUserIdResponse_userId - The identifier for a user in the identity store.

GetUserId, getUserIdResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

getUserIdResponse_httpStatus :: Lens' GetUserIdResponse Int Source #

The response's http status code.

getUserIdResponse_userId :: Lens' GetUserIdResponse Text Source #

The identifier for a user in the identity store.

getUserIdResponse_identityStoreId :: Lens' GetUserIdResponse Text Source #

The globally unique identifier for the identity store.