Skip to content

ListIdentitiesInput

Source code in docs_src/capo_cognito_identity/types/list_identities_input.py
class ListIdentitiesInput(TypedDict, closed=True):
    identity_pool_id: "capo_cognito_identity.types.identity_pool_id.IdentityPoolId"
    """<p>An identity pool ID in the format REGION:GUID.</p>"""
    max_results: "capo_cognito_identity.types.query_limit.QueryLimit"
    """<p>The maximum number of identities to return.</p>"""
    next_token: NotRequired["capo_cognito_identity.types.pagination_key.PaginationKey"]
    """<p>A pagination token.</p>"""
    hide_disabled: "capo_cognito_identity.types.hide_disabled.HideDisabled"
    """<p>An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.</p>"""

hide_disabled instance-attribute

hide_disabled: HideDisabled

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 instance-attribute

identity_pool_id: IdentityPoolId

An identity pool ID in the format REGION:GUID.

max_results instance-attribute

max_results: QueryLimit

The maximum number of identities to return.

next_token instance-attribute

next_token: NotRequired[PaginationKey]

A pagination token.