lookup_developer_identity¶
Operation¶
async
¶
lookup_developer_identity(input: LookupDeveloperIdentityInput, plugins: list[Plugin] | None = None) -> LookupDeveloperIdentityOutput
Retrieves the IdentityID associated with a DeveloperUserIdentifier
or the list of DeveloperUserIdentifier values associated with an
IdentityId for an existing identity. Either IdentityID or
DeveloperUserIdentifier must not be null. If you supply only one of
these values, the other value will be searched in the database and
returned as a part of the response. If you supply both,
DeveloperUserIdentifier will be matched against IdentityID. If the
values are verified against the database, the response returns both
values and is the same as the request. Otherwise, a
ResourceConflictException is thrown.
LookupDeveloperIdentity is intended for low-throughput control plane
operations: for example, to enable customer service to locate an
identity ID by username. If you are using it for higher-volume
operations such as user authentication, your requests are likely to be
throttled. GetOpenIdTokenForDeveloperIdentity is a better option for
higher-volume operations for user authentication.
You must use Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
LookupDeveloperIdentityInput
|
An instance of |
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 |
|---|---|
LookupDeveloperIdentityOutput
|
An instance of |
Input¶
dataclass
¶
Input to the LookupDeveloperIdentityInput action.
Attributes¶
class-attribute
instance-attribute
¶
developer_user_identifier: str | None = None
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.
class-attribute
instance-attribute
¶
identity_id: str | None = None
A unique identifier in the format REGION:GUID.
class-attribute
instance-attribute
¶
identity_pool_id: str | None = None
An identity pool ID in the format REGION:GUID.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of identities to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
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.
Output¶
dataclass
¶
Returned in response to a successful LookupDeveloperIdentity action.
Attributes¶
class-attribute
instance-attribute
¶
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
class-attribute
instance-attribute
¶
identity_id: str | None = None
A unique identifier in the format REGION:GUID.
class-attribute
instance-attribute
¶
next_token: str | None = None
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.