CognitoIdentity / Client / get_credentials_for_identity

get_credentials_for_identity#

CognitoIdentity.Client.get_credentials_for_identity(**kwargs)#

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

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_credentials_for_identity(
    IdentityId='string',
    Logins={
        'string': 'string'
    },
    CustomRoleArn='string'
)
Parameters:

  • IdentityId (string) –

    [REQUIRED]

    A unique identifier in the format REGION:GUID.

  • Logins (dict) –

    A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax “provider_name”: “provider_user_identifier”.

    Logins should not be specified when trying to get credentials for an unauthenticated identity.

    The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

    • (string) –

      • (string) –

  • CustomRoleArn (string) – The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityId': 'string',
    'Credentials': {
        'AccessKeyId': 'string',
        'SecretKey': 'string',
        'SessionToken': 'string',
        'Expiration': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    Returned in response to a successful GetCredentialsForIdentity operation.

    • IdentityId (string) –

      A unique identifier in the format REGION:GUID.

    • Credentials (dict) –

      Credentials for the provided identity ID.

      • AccessKeyId (string) –

        The Access Key portion of the credentials.

      • SecretKey (string) –

        The Secret Access Key portion of the credentials

      • SessionToken (string) –

        The Session Token portion of the credentials

      • Expiration (datetime) –

        The date at which these credentials will expire.

Exceptions

  • CognitoIdentity.Client.exceptions.InvalidParameterException

  • CognitoIdentity.Client.exceptions.ResourceNotFoundException

  • CognitoIdentity.Client.exceptions.NotAuthorizedException

  • CognitoIdentity.Client.exceptions.ResourceConflictException

  • CognitoIdentity.Client.exceptions.TooManyRequestsException

  • CognitoIdentity.Client.exceptions.InvalidIdentityPoolConfigurationException

  • CognitoIdentity.Client.exceptions.InternalErrorException

  • CognitoIdentity.Client.exceptions.ExternalServiceException