Skip to content

LookupDeveloperIdentityInput

Source code in docs_src/capo_cognito_identity/types/lookup_developer_identity_input.py
class LookupDeveloperIdentityInput(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>"""
    identity_id: NotRequired["capo_cognito_identity.types.identity_id.IdentityId"]
    """<p>A unique identifier in the format REGION:GUID.</p>"""
    developer_user_identifier: NotRequired[
        "capo_cognito_identity.types.developer_user_identifier.DeveloperUserIdentifier"
    ]
    """<p>A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.</p>"""
    max_results: NotRequired["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. The first call you make will have <code>NextToken</code> set to null. After that the service will return <code>NextToken</code> values as needed. For example, let's say you make a request with <code>MaxResults</code> set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.</p>"""

developer_user_identifier instance-attribute

developer_user_identifier: NotRequired[DeveloperUserIdentifier]

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

identity_id instance-attribute

identity_id: NotRequired[IdentityId]

A unique identifier in the format REGION:GUID.

identity_pool_id instance-attribute

identity_pool_id: IdentityPoolId

An identity pool ID in the format REGION:GUID.

max_results instance-attribute

max_results: NotRequired[QueryLimit]

The maximum number of identities to return.

next_token instance-attribute

next_token: NotRequired[PaginationKey]

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.