CognitoIdentity / Client / get_id
get_id#
- CognitoIdentity.Client.get_id(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.get_id( AccountId='string', IdentityPoolId='string', Logins={ 'string': 'string' } )
- Parameters:
AccountId (string) – A standard AWS account ID (9+ digits).
IdentityPoolId (string) –
[REQUIRED]
An identity pool ID in the format REGION:GUID.
Logins (dict) –
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 user pool:
cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>
, for example,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
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'IdentityId': 'string' }
Response Structure
(dict) –
Returned in response to a GetId request.
IdentityId (string) –
A unique identifier in the format REGION:GUID.
Exceptions
CognitoIdentity.Client.exceptions.InvalidParameterException
CognitoIdentity.Client.exceptions.ResourceNotFoundException
CognitoIdentity.Client.exceptions.NotAuthorizedException
CognitoIdentity.Client.exceptions.ResourceConflictException
CognitoIdentity.Client.exceptions.TooManyRequestsException
CognitoIdentity.Client.exceptions.InternalErrorException
CognitoIdentity.Client.exceptions.LimitExceededException
CognitoIdentity.Client.exceptions.ExternalServiceException