Skip to content

Cognito Identity  >  Operations  >  list_identity_pools

list_identity_pools

Operation

list_identity_pools async 

list_identity_pools(input: ListIdentityPoolsInput, plugins: list[Plugin] | None = None) -> ListIdentityPoolsOutput

Lists all of the Cognito identity pools registered for your account.

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

Parameters:

Name Type Description Default
input ListIdentityPoolsInput

An instance of ListIdentityPoolsInput.

 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
ListIdentityPoolsOutput

An instance of ListIdentityPoolsOutput.

Input

ListIdentityPoolsInput dataclass

Input to the ListIdentityPools action.

Attributes

max_results class-attribute instance-attribute 
max_results: int | None = None

The maximum number of identities to return.

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

A pagination token.

Output

ListIdentityPoolsOutput dataclass

The result of a successful ListIdentityPools action.

Attributes

identity_pools class-attribute instance-attribute 
identity_pools: list[IdentityPoolShortDescription] | None = None

The identity pools returned by the ListIdentityPools action.

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

A pagination token.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.