| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@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.
- 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* 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 Source # | |
| Data GetId Source # | |
| Read GetId Source # | |
| Show GetId Source # | |
| Generic GetId Source # | |
| Hashable GetId Source # | |
| ToJSON GetId Source # | |
| NFData GetId Source # | |
| AWSRequest GetId Source # | |
| ToPath GetId Source # | |
| ToHeaders GetId Source # | |
| ToQuery GetId Source # | |
| type Rep GetId Source # | |
| type Rs GetId Source # | |
Request Lenses
giLogins :: Lens' GetId (HashMap Text Text) Source #
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 * Google: accounts.google.com * Amazon: www.amazon.com * Twitter: api.twitter.com * Digits: www.digits.com
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 Source #
Returned in response to a GetId request.
See: getIdResponse smart constructor.
Response Lenses
girsIdentityId :: Lens' GetIdResponse (Maybe Text) Source #
A unique identifier in the format REGION:GUID.
girsResponseStatus :: Lens' GetIdResponse Int Source #
- - | The response status code.