CognitoIdentity / Client / describe_identity

describe_identity#

CognitoIdentity.Client.describe_identity(**kwargs)#

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.

Request Syntax

response = client.describe_identity(
    IdentityId='string'
)

Parameters:

IdentityId (string) –

[REQUIRED]

A unique identifier in the format REGION:GUID.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityId': 'string',
    'Logins': [
        'string',
    ],
    'CreationDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –

A description of the identity.
- IdentityId (string) –
  
  A unique identifier in the format REGION:GUID.
- Logins (list) –
  
  The provider names.
  - (string) –
- CreationDate (datetime) –
  
  Date on which the identity was created.
- LastModifiedDate (datetime) –
  
  Date on which the identity was last modified.

Exceptions

CognitoIdentity.Client.exceptions.InvalidParameterException
CognitoIdentity.Client.exceptions.ResourceNotFoundException
CognitoIdentity.Client.exceptions.NotAuthorizedException
CognitoIdentity.Client.exceptions.TooManyRequestsException
CognitoIdentity.Client.exceptions.InternalErrorException