describe_identity_pool¶
Operation¶
describe_identity_pool
¶
describe_identity_pool(request: DescribeIdentityPoolInput | DescribeIdentityPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityPoolInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeIdentityPoolInput | DescribeIdentityPoolInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeIdentityPoolInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeIdentityPoolOutput
|
An instance of |
describe_identity_pool
async
¶
describe_identity_pool(request: DescribeIdentityPoolInput | DescribeIdentityPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityPoolInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeIdentityPoolInput | DescribeIdentityPoolInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeIdentityPoolInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeIdentityPoolOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DescribeIdentityPoolOutput
dataclass
¶
Bases: _SerdeShape
An object representing an Amazon Cognito identity pool.
Attributes¶
allow_classic_flow
class-attribute
instance-attribute
¶
allow_classic_flow: bool | 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 = ...
TRUE if the identity pool supports unauthenticated logins.
cognito_identity_providers
class-attribute
instance-attribute
¶
cognito_identity_providers: list[CognitoIdentityProvider] | 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 = ...
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_tags
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.
open_id_connect_provider_ar_ns
class-attribute
instance-attribute
¶
The ARNs of the OpenID Connect providers.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
saml_provider_ar_ns
class-attribute
instance-attribute
¶
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.