lookup_developer_identity
async
¶
lookup_developer_identity(
identity_pool_id: IdentityPoolId,
*,
config_overrides: Optional[AsyncCognitoIdentityClientConfig] = None,
identity_id: Optional[IdentityId] = None,
developer_user_identifier: Optional[DeveloperUserIdentifier] = None,
max_results: Optional[QueryLimit] = None,
next_token: Optional[PaginationKey] = None,
) -> LookupDeveloperIdentityResponse
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:
-
identity_pool_id(IdentityPoolId) –An identity pool ID in the format REGION:GUID.
-
identity_id(Optional[IdentityId], default:None) –A unique identifier in the format REGION:GUID.
-
developer_user_identifier(Optional[DeveloperUserIdentifier], default: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.
-
max_results(Optional[QueryLimit], default:None) –The maximum number of identities to return.
-
next_token(Optional[PaginationKey], default:None) –A pagination token. The first call you make will have
NextTokenset to null. After that the service will returnNextTokenvalues as needed. For example, let's say you make a request withMaxResultsset 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.
Raises:
-
InternalErrorException–Thrown when the service encounters an error during processing the request.
-
InvalidParameterException–Thrown for missing or bad input parameter(s).
-
NotAuthorizedException–Thrown when a user is not authorized to access the requested resource.
-
ResourceConflictException–Thrown when a user tries to use a login which is already linked to another account.
-
ResourceNotFoundException–Thrown when the requested resource (for example, a dataset or record) does not exist.
-
TooManyRequestsException–Thrown when a request is throttled.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_cognito_identity/_services/async_cognito_identity.py
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 | |