Struct aws_sdk_cognitoidentity::client::fluent_builders::LookupDeveloperIdentity

pub struct LookupDeveloperIdentity { /* private fields */ }

Fluent builder constructing a request to LookupDeveloperIdentity.

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 AWS Developer credentials to call this API.

Implementations

impl LookupDeveloperIdentity

pub async fn send(
    self
) -> Result<LookupDeveloperIdentityOutput, SdkError<LookupDeveloperIdentityError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn identity_pool_id(self, input: impl Into<String>) -> Self

An identity pool ID in the format REGION:GUID.

pub fn set_identity_pool_id(self, input: Option<String>) -> Self

An identity pool ID in the format REGION:GUID.

pub fn identity_id(self, input: impl Into<String>) -> Self

A unique identifier in the format REGION:GUID.

pub fn set_identity_id(self, input: Option<String>) -> Self

A unique identifier in the format REGION:GUID.

pub fn developer_user_identifier(self, input: impl Into<String>) -> Self

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.

pub fn set_developer_user_identifier(self, input: Option<String>) -> Self

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.

pub fn max_results(self, input: i32) -> Self

The maximum number of identities to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of identities to return.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for LookupDeveloperIdentity

fn clone(&self) -> LookupDeveloperIdentity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LookupDeveloperIdentity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.