Skip to content

Cognito Identity  >  Operations  >  list_identities

list_identities

Operation

list_identities async 

list_identities(input: ListIdentitiesInput, plugins: list[Plugin] | None = None) -> ListIdentitiesOutput

Lists the identities in an identity pool.

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

Parameters:

Name Type Description Default
input ListIdentitiesInput

An instance of ListIdentitiesInput.

 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
ListIdentitiesOutput

An instance of ListIdentitiesOutput.

Input

ListIdentitiesInput dataclass

Input to the ListIdentities action.

Attributes

hide_disabled class-attribute instance-attribute 
hide_disabled: bool = False

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

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

An identity pool ID in the format REGION:GUID.

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

ListIdentitiesOutput dataclass

The response to a ListIdentities request.

Attributes

identities class-attribute instance-attribute 
identities: list[IdentityDescription] | None = None

An object containing a set of identities and associated mappings.

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

An identity pool ID in the format REGION:GUID.

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

A pagination token.