| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.CognitoIdentity.GetId
Description
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
Synopsis
- getId :: Text -> GetId
- data GetId
- giAccountId :: Lens' GetId (Maybe Text)
- giLogins :: Lens' GetId (HashMap Text Text)
- giIdentityPoolId :: Lens' GetId Text
- getIdResponse :: Int -> GetIdResponse
- data GetIdResponse
- girsIdentityId :: Lens' GetIdResponse (Maybe Text)
- girsResponseStatus :: Lens' GetIdResponse Int
Creating a Request
Creates a value of GetId with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
giAccountId- A standard AWS account ID (9+ digits).giLogins- A set of optional name-value pairs that map provider names to provider tokens. The available provider names forLoginsare as follows: * Facebook:graph.facebook.com* Amazon Cognito Identity Provider:cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789* Google:accounts.google.com* Amazon:www.amazon.com* Twitter:api.twitter.com* Digits:www.digits.comgiIdentityPoolId- An identity pool ID in the format REGION:GUID.
Input to the GetId action.
See: getId smart constructor.
Instances
| Eq GetId # | |
| Data GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetId -> c GetId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetId # dataTypeOf :: GetId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetId) # gmapT :: (forall b. Data b => b -> b) -> GetId -> GetId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetId -> r # gmapQ :: (forall d. Data d => d -> u) -> GetId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetId -> m GetId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetId -> m GetId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetId -> m GetId # | |
| Read GetId # | |
| Show GetId # | |
| Generic GetId # | |
| Hashable GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId | |
| ToJSON GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId | |
| AWSRequest GetId # | |
| ToHeaders GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId | |
| ToPath GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId Methods toPath :: GetId -> ByteString # | |
| ToQuery GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId Methods toQuery :: GetId -> QueryString # | |
| NFData GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId | |
| type Rep GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId type Rep GetId = D1 (MetaData "GetId" "Network.AWS.CognitoIdentity.GetId" "amazonka-cognito-identity-1.6.0-5mXAaCwjGbj7HkjMdo2fHw" False) (C1 (MetaCons "GetId'" PrefixI True) (S1 (MetaSel (Just "_giAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_giLogins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_giIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) | |
| type Rs GetId # | |
Defined in Network.AWS.CognitoIdentity.GetId | |
Request Lenses
giLogins :: Lens' GetId (HashMap Text Text) #
A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows: * Facebook: graph.facebook.com * Amazon Cognito Identity Provider: cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 * Google: accounts.google.com * Amazon: www.amazon.com * Twitter: api.twitter.com * Digits: www.digits.com
giIdentityPoolId :: Lens' GetId Text #
An identity pool ID in the format REGION:GUID.
Destructuring the Response
Arguments
| :: Int | |
| -> GetIdResponse |
Creates a value of GetIdResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
girsIdentityId- A unique identifier in the format REGION:GUID.girsResponseStatus- -- | The response status code.
data GetIdResponse #
Returned in response to a GetId request.
See: getIdResponse smart constructor.
Instances
Response Lenses
girsIdentityId :: Lens' GetIdResponse (Maybe Text) #
A unique identifier in the format REGION:GUID.
girsResponseStatus :: Lens' GetIdResponse Int #
- - | The response status code.