Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142311090.8 KB

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.

post/#X-Amz-Target=AWSCognitoIdentityService.DescribeIdentityPool

Headers

X-Amz-Target'AWSCognitoIdentityService.DescribeIdentityPool' required

Request body

IdentityPoolIdstring required

An identity pool ID in the format REGION:GUID.

Response

Success

IdentityPoolIdstring required

An identity pool ID in the format REGION:GUID.

IdentityPoolNamestring required

A string that you provide.

AllowUnauthenticatedIdentitiesboolean required

TRUE if the identity pool supports unauthenticated logins.

AllowClassicFlowboolean

Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>.

SupportedLoginProvidersobject

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

DeveloperProviderNamestring

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

OpenIdConnectProviderARNsARNString[]

The ARNs of the OpenID Connect providers.

SamlProviderARNsARNString[]

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

IdentityPoolTagsobject

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.