Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentity.DescribeIdentity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Creating a Request

data DescribeIdentity Source #

Input to the DescribeIdentity action.

See: newDescribeIdentity smart constructor.

Constructors

DescribeIdentity'
Fields identityId :: Text A unique identifier in the format REGION:GUID.

Instances

Instances details

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

newDescribeIdentity Source #

Arguments

:: Text	`$sel:identityId:DescribeIdentity'`
-> DescribeIdentity

Create a value of DescribeIdentity 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:identityId:DescribeIdentity', describeIdentity_identityId - A unique identifier in the format REGION:GUID.

Request Lenses

describeIdentity_identityId :: Lens' DescribeIdentity Text Source #

A unique identifier in the format REGION:GUID.

Destructuring the Response

data IdentityDescription Source #

A description of the identity.

See: newIdentityDescription smart constructor.

Constructors

IdentityDescription'
Fields lastModifiedDate :: Maybe POSIX Date on which the identity was last modified. creationDate :: Maybe POSIX Date on which the identity was created. logins :: Maybe [Text] The provider names. identityId :: Maybe Text A unique identifier in the format REGION:GUID.

Instances

Instances details

Eq IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods (==) :: IdentityDescription -> IdentityDescription -> Bool # (/=) :: IdentityDescription -> IdentityDescription -> Bool #
Read IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods readsPrec :: Int -> ReadS IdentityDescription # readList :: ReadS [IdentityDescription] # readPrec :: ReadPrec IdentityDescription # readListPrec :: ReadPrec [IdentityDescription] #
Show IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods showsPrec :: Int -> IdentityDescription -> ShowS # show :: IdentityDescription -> String # showList :: [IdentityDescription] -> ShowS #
Generic IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Associated Types type Rep IdentityDescription :: Type -> Type # Methods from :: IdentityDescription -> Rep IdentityDescription x # to :: Rep IdentityDescription x -> IdentityDescription #
NFData IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods rnf :: IdentityDescription -> () #
Hashable IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods hashWithSalt :: Int -> IdentityDescription -> Int # hash :: IdentityDescription -> Int #
FromJSON IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription Methods parseJSON :: Value -> Parser IdentityDescription # parseJSONList :: Value -> Parser [IdentityDescription] #
type Rep IdentityDescription Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityDescription type Rep IdentityDescription = D1 ('MetaData "IdentityDescription" "Amazonka.CognitoIdentity.Types.IdentityDescription" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "IdentityDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "logins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newIdentityDescription :: IdentityDescription Source #

Create a value of IdentityDescription 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:lastModifiedDate:IdentityDescription', identityDescription_lastModifiedDate - Date on which the identity was last modified.

$sel:creationDate:IdentityDescription', identityDescription_creationDate - Date on which the identity was created.

$sel:logins:IdentityDescription', identityDescription_logins - The provider names.

$sel:identityId:IdentityDescription', identityDescription_identityId - A unique identifier in the format REGION:GUID.

Response Lenses

identityDescription_lastModifiedDate :: Lens' IdentityDescription (Maybe UTCTime) Source #

Date on which the identity was last modified.

identityDescription_creationDate :: Lens' IdentityDescription (Maybe UTCTime) Source #

Date on which the identity was created.

identityDescription_logins :: Lens' IdentityDescription (Maybe [Text]) Source #

The provider names.

identityDescription_identityId :: Lens' IdentityDescription (Maybe Text) Source #

A unique identifier in the format REGION:GUID.