update_identity_pool¶
Operation¶
async
¶
update_identity_pool(input: UpdateIdentityPoolInput, plugins: list[Plugin] | None = None) -> UpdateIdentityPoolOutput
Updates the configuration of an identity pool.
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
|
UpdateIdentityPoolInput
|
An instance of |
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 |
|---|---|
UpdateIdentityPoolOutput
|
An instance of |
Input¶
dataclass
¶
An object representing an Amazon Cognito identity pool.
Attributes¶
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.
class-attribute
instance-attribute
¶
allow_unauthenticated_identities: bool = False
TRUE if the identity pool supports unauthenticated logins.
class-attribute
instance-attribute
¶
cognito_identity_providers: list[CognitoIdentityProvider] | None = None
A list representing an Amazon Cognito user pool and its client ID.
class-attribute
instance-attribute
¶
developer_provider_name: str | None = None
The "domain" by which Cognito will refer to your users.
class-attribute
instance-attribute
¶
identity_pool_id: str | None = None
An identity pool ID in the format REGION:GUID.
class-attribute
instance-attribute
¶
identity_pool_name: str | None = None
A string that you provide.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
The ARNs of the OpenID Connect providers.
class-attribute
instance-attribute
¶
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Output¶
dataclass
¶
An object representing an Amazon Cognito identity pool.
Attributes¶
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.
class-attribute
instance-attribute
¶
allow_unauthenticated_identities: bool = False
TRUE if the identity pool supports unauthenticated logins.
class-attribute
instance-attribute
¶
cognito_identity_providers: list[CognitoIdentityProvider] | None = None
A list representing an Amazon Cognito user pool and its client ID.
class-attribute
instance-attribute
¶
developer_provider_name: str | None = None
The "domain" by which Cognito will refer to your users.
instance-attribute
¶
identity_pool_id: str
An identity pool ID in the format REGION:GUID.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
The ARNs of the OpenID Connect providers.
class-attribute
instance-attribute
¶
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.