Skip to content

Cognito Identity  >  Operations  >  create_identity_pool

create_identity_pool

Operation

create_identity_pool async 

create_identity_pool(input: CreateIdentityPoolInput, plugins: list[Plugin] | None = None) -> CreateIdentityPoolOutput

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Sign in With Apple: appleid.apple.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

Warning

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.

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

Parameters:

Name Type Description Default
input CreateIdentityPoolInput

An instance of CreateIdentityPoolInput.

 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
CreateIdentityPoolOutput

An instance of CreateIdentityPoolOutput.

Input

CreateIdentityPoolInput dataclass

Input to the CreateIdentityPool action.

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

An array of Amazon Cognito user pools and their client IDs.

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

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

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

A string that you provide.

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

Tags to assign 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 Amazon Resource Names (ARN) 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.

Output

CreateIdentityPoolOutput 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.