Skip to content

Cognito Identity  >  Operations  >  describe_identity_pool

describe_identity_pool

Operation

describe_identity_pool async 

describe_identity_pool(input: DescribeIdentityPoolInput, plugins: list[Plugin] | None = None) -> DescribeIdentityPoolOutput

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

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

Name Type Description Default
input DescribeIdentityPoolInput

An instance of DescribeIdentityPoolInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeIdentityPoolOutput

An instance of DescribeIdentityPoolOutput.

Input

DescribeIdentityPoolInput dataclass

Input to the DescribeIdentityPool action.

Attributes

identity_pool_id class-attribute instance-attribute 
identity_pool_id: str | None = None

An identity pool ID in the format REGION:GUID.

Output

DescribeIdentityPoolOutput dataclass

An object representing an Amazon Cognito identity pool.

Attributes

allow_classic_flow class-attribute instance-attribute 
allow_classic_flow: bool | None = None

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

allow_unauthenticated_identities class-attribute instance-attribute 
allow_unauthenticated_identities: bool = False

TRUE if the identity pool supports unauthenticated logins.

cognito_identity_providers class-attribute instance-attribute 
cognito_identity_providers: list[CognitoIdentityProvider] | None = None

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

developer_provider_name class-attribute instance-attribute 
developer_provider_name: str | None = None

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

identity_pool_id instance-attribute 
identity_pool_id: str

An identity pool ID in the format REGION:GUID.

identity_pool_name instance-attribute 
identity_pool_name: str

A string that you provide.

identity_pool_tags class-attribute instance-attribute 
identity_pool_tags: dict[str, str] | None = None

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.

open_id_connect_provider_ar_ns class-attribute instance-attribute 
open_id_connect_provider_ar_ns: list[str] | None = None

The ARNs of the OpenID Connect providers.

saml_provider_ar_ns class-attribute instance-attribute 
saml_provider_ar_ns: list[str] | None = None

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

supported_login_providers class-attribute instance-attribute 
supported_login_providers: dict[str, str] | None = None

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