Skip to content

list_identity_pools

Operation

list_identity_pools

list_identity_pools(request: ListIdentityPoolsInput | ListIdentityPoolsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIdentityPoolsInputDict]) -> 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
request ListIdentityPoolsInput | ListIdentityPoolsInputDict | 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[ListIdentityPoolsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListIdentityPoolsOutput

An instance of ListIdentityPoolsOutput.

list_identity_pools async

list_identity_pools(request: ListIdentityPoolsInput | ListIdentityPoolsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIdentityPoolsInputDict]) -> 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
request ListIdentityPoolsInput | ListIdentityPoolsInputDict | 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[ListIdentityPoolsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListIdentityPoolsOutput

An instance of ListIdentityPoolsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListIdentityPoolsInputDict

Bases: TypedDict

Dictionary form of ListIdentityPoolsInput.

Attributes

max_results instance-attribute
max_results: Required[int]

The maximum number of identities to return.

next_token instance-attribute
next_token: str | None

A pagination token.

ListIdentityPoolsInput dataclass

Bases: _SerdeShape

Input to the ListIdentityPools action.

Attributes

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

The maximum number of identities to return.

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

A pagination token.

Output

ListIdentityPoolsOutput dataclass

Bases: _SerdeShape

The result of a successful ListIdentityPools action.

Attributes

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

The identity pools returned by the ListIdentityPools action.

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

A pagination token.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.