describe_identity_pool

describe_identity_pool(**kwargs)

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

See also: AWS API Documentation

Request Syntax

response = client.describe_identity_pool(
    IdentityPoolId='string'
)

Parameters

IdentityPoolId (string) --

[REQUIRED]

An identity pool ID in the format REGION:GUID.

Return type

dict

Returns

Response Syntax

{
    'IdentityPoolId': 'string',
    'IdentityPoolName': 'string',
    'AllowUnauthenticatedIdentities': True|False,
    'AllowClassicFlow': True|False,
    'SupportedLoginProviders': {
        'string': 'string'
    },
    'DeveloperProviderName': 'string',
    'OpenIdConnectProviderARNs': [
        'string',
    ],
    'CognitoIdentityProviders': [
        {
            'ProviderName': 'string',
            'ClientId': 'string',
            'ServerSideTokenCheck': True|False
        },
    ],
    'SamlProviderARNs': [
        'string',
    ],
    'IdentityPoolTags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  An object representing an Amazon Cognito identity pool.

  • IdentityPoolId (string) --

    An identity pool ID in the format REGION:GUID.

  • IdentityPoolName (string) --

    A string that you provide.

  • AllowUnauthenticatedIdentities (boolean) --

    TRUE if the identity pool supports unauthenticated logins.

  • AllowClassicFlow (boolean) --

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide .

  • SupportedLoginProviders (dict) --

    Optional key:value pairs mapping provider names to provider app IDs.

    • (string) --
      • (string) --
  • DeveloperProviderName (string) --

    The "domain" by which Cognito will refer to your users.

  • OpenIdConnectProviderARNs (list) --

    The ARNs of the OpenID Connect providers.

    • (string) --
  • CognitoIdentityProviders (list) --

    A list representing an Amazon Cognito user pool and its client ID.

    • (dict) --

      A provider representing an Amazon Cognito user pool and its client ID.

      • ProviderName (string) --

        The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

      • ClientId (string) --

        The client ID for the Amazon Cognito user pool.

      • ServerSideTokenCheck (boolean) --

        TRUE if server-side token validation is enabled for the identity provider’s token.

        Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

        If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

  • SamlProviderARNs (list) --

    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

    • (string) --
  • IdentityPoolTags (dict) --

    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

    • (string) --
      • (string) --

Exceptions

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