com.amazonaws.services.cognitoidentity.model

Class LookupDeveloperIdentityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class LookupDeveloperIdentityRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the LookupDeveloperIdentity operation.

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s 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.

You must use AWS Developer credentials to call this API.

See Also:

AmazonCognitoIdentity.lookupDeveloperIdentity(LookupDeveloperIdentityRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
LookupDeveloperIdentityRequest()

Method Summary

Methods

Modifier and Type	Method and Description
LookupDeveloperIdentityRequest	clone()
boolean	equals(Object obj)
String	getDeveloperUserIdentifier() A unique ID used by your backend authentication process to identify a user.
String	getIdentityId() A unique identifier in the format REGION:GUID.
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
Integer	getMaxResults() The maximum number of identities to return.
String	getNextToken() A pagination token.
int	hashCode()
void	setDeveloperUserIdentifier(String developerUserIdentifier) A unique ID used by your backend authentication process to identify a user.
void	setIdentityId(String identityId) A unique identifier in the format REGION:GUID.
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setMaxResults(Integer maxResults) The maximum number of identities to return.
void	setNextToken(String nextToken) A pagination token.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LookupDeveloperIdentityRequest	withDeveloperUserIdentifier(String developerUserIdentifier) A unique ID used by your backend authentication process to identify a user.
LookupDeveloperIdentityRequest	withIdentityId(String identityId) A unique identifier in the format REGION:GUID.
LookupDeveloperIdentityRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
LookupDeveloperIdentityRequest	withMaxResults(Integer maxResults) The maximum number of identities to return.
LookupDeveloperIdentityRequest	withNextToken(String nextToken) A pagination token.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LookupDeveloperIdentityRequest

public LookupDeveloperIdentityRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public LookupDeveloperIdentityRequest withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getIdentityId

public String getIdentityId()

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A unique identifier in the format REGION:GUID.

setIdentityId

public void setIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - A unique identifier in the format REGION:GUID.

withIdentityId

public LookupDeveloperIdentityRequest withIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - A unique identifier in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getDeveloperUserIdentifier

public String getDeveloperUserIdentifier()

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.

Constraints:
Length: 1 - 1024
Pattern: [\w.@_-]+

Returns:

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.

setDeveloperUserIdentifier

public void setDeveloperUserIdentifier(String 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.

Constraints:
Length: 1 - 1024
Pattern: [\w.@_-]+

Parameters:

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.

withDeveloperUserIdentifier

public LookupDeveloperIdentityRequest withDeveloperUserIdentifier(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024
Pattern: [\w.@_-]+

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of identities to return.

Constraints:
Range: 1 - 60

Returns:

The maximum number of identities to return.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of identities to return.

Constraints:
Range: 1 - 60

Parameters:

maxResults - The maximum number of identities to return.

withMaxResults

public LookupDeveloperIdentityRequest withMaxResults(Integer maxResults)

The maximum number of identities to return.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 60

Parameters:

maxResults - The maximum number of identities to return.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

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.

Constraints:
Length: 1 -
Pattern: [\S]+

Returns:

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.

setNextToken

public void setNextToken(String nextToken)

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.

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

nextToken - 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.

withNextToken

public LookupDeveloperIdentityRequest withNextToken(String nextToken)

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

nextToken - 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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public LookupDeveloperIdentityRequest clone()

Overrides:

clone in class AmazonWebServiceRequest