amazonka-cognito-identity-1.6.0: Amazon Cognito Identity SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentity.LookupDeveloperIdentity

Contents

Description

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID . If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

You must use AWS Developer credentials to call this API.

Synopsis

Creating a Request

lookupDeveloperIdentity #

Creates a value of LookupDeveloperIdentity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ldiDeveloperUserIdentifier - A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
  • ldiNextToken - A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
  • ldiIdentityId - A unique identifier in the format REGION:GUID.
  • ldiMaxResults - The maximum number of identities to return.
  • ldiIdentityPoolId - An identity pool ID in the format REGION:GUID.

data LookupDeveloperIdentity #

Input to the LookupDeveloperIdentityInput action.

See: lookupDeveloperIdentity smart constructor.

Instances

Eq LookupDeveloperIdentity # 
Data LookupDeveloperIdentity # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LookupDeveloperIdentity -> c LookupDeveloperIdentity #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LookupDeveloperIdentity #

toConstr :: LookupDeveloperIdentity -> Constr #

dataTypeOf :: LookupDeveloperIdentity -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LookupDeveloperIdentity) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LookupDeveloperIdentity) #

gmapT :: (forall b. Data b => b -> b) -> LookupDeveloperIdentity -> LookupDeveloperIdentity #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LookupDeveloperIdentity -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LookupDeveloperIdentity -> r #

gmapQ :: (forall d. Data d => d -> u) -> LookupDeveloperIdentity -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LookupDeveloperIdentity -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentity -> m LookupDeveloperIdentity #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentity -> m LookupDeveloperIdentity #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentity -> m LookupDeveloperIdentity #

Read LookupDeveloperIdentity # 
Show LookupDeveloperIdentity # 
Generic LookupDeveloperIdentity # 
Hashable LookupDeveloperIdentity # 
ToJSON LookupDeveloperIdentity # 
NFData LookupDeveloperIdentity # 

Methods

rnf :: LookupDeveloperIdentity -> () #

AWSRequest LookupDeveloperIdentity # 
ToHeaders LookupDeveloperIdentity # 
ToPath LookupDeveloperIdentity # 
ToQuery LookupDeveloperIdentity # 
type Rep LookupDeveloperIdentity # 
type Rep LookupDeveloperIdentity = D1 * (MetaData "LookupDeveloperIdentity" "Network.AWS.CognitoIdentity.LookupDeveloperIdentity" "amazonka-cognito-identity-1.6.0-7Jg9Nyngsx05LwQn1SZzEq" False) (C1 * (MetaCons "LookupDeveloperIdentity'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ldiDeveloperUserIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ldiNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ldiIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ldiMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ldiIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs LookupDeveloperIdentity # 

Request Lenses

ldiDeveloperUserIdentifier :: Lens' LookupDeveloperIdentity (Maybe Text) #

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

ldiNextToken :: Lens' LookupDeveloperIdentity (Maybe Text) #

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

ldiIdentityId :: Lens' LookupDeveloperIdentity (Maybe Text) #

A unique identifier in the format REGION:GUID.

ldiMaxResults :: Lens' LookupDeveloperIdentity (Maybe Natural) #

The maximum number of identities to return.

ldiIdentityPoolId :: Lens' LookupDeveloperIdentity Text #

An identity pool ID in the format REGION:GUID.

Destructuring the Response

lookupDeveloperIdentityResponse #

Creates a value of LookupDeveloperIdentityResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ldirsNextToken - A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
  • ldirsIdentityId - A unique identifier in the format REGION:GUID.
  • ldirsDeveloperUserIdentifierList - This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
  • ldirsResponseStatus - -- | The response status code.

data LookupDeveloperIdentityResponse #

Returned in response to a successful LookupDeveloperIdentity action.

See: lookupDeveloperIdentityResponse smart constructor.

Instances

Eq LookupDeveloperIdentityResponse # 
Data LookupDeveloperIdentityResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LookupDeveloperIdentityResponse -> c LookupDeveloperIdentityResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LookupDeveloperIdentityResponse #

toConstr :: LookupDeveloperIdentityResponse -> Constr #

dataTypeOf :: LookupDeveloperIdentityResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LookupDeveloperIdentityResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LookupDeveloperIdentityResponse) #

gmapT :: (forall b. Data b => b -> b) -> LookupDeveloperIdentityResponse -> LookupDeveloperIdentityResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LookupDeveloperIdentityResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LookupDeveloperIdentityResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> LookupDeveloperIdentityResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LookupDeveloperIdentityResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentityResponse -> m LookupDeveloperIdentityResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentityResponse -> m LookupDeveloperIdentityResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LookupDeveloperIdentityResponse -> m LookupDeveloperIdentityResponse #

Read LookupDeveloperIdentityResponse # 
Show LookupDeveloperIdentityResponse # 
Generic LookupDeveloperIdentityResponse # 
NFData LookupDeveloperIdentityResponse # 
type Rep LookupDeveloperIdentityResponse # 
type Rep LookupDeveloperIdentityResponse = D1 * (MetaData "LookupDeveloperIdentityResponse" "Network.AWS.CognitoIdentity.LookupDeveloperIdentity" "amazonka-cognito-identity-1.6.0-7Jg9Nyngsx05LwQn1SZzEq" False) (C1 * (MetaCons "LookupDeveloperIdentityResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ldirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ldirsIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ldirsDeveloperUserIdentifierList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_ldirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ldirsNextToken :: Lens' LookupDeveloperIdentityResponse (Maybe Text) #

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

ldirsIdentityId :: Lens' LookupDeveloperIdentityResponse (Maybe Text) #

A unique identifier in the format REGION:GUID.

ldirsDeveloperUserIdentifierList :: Lens' LookupDeveloperIdentityResponse [Text] #

This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.