com.amazonaws.services.cognitoidentity.model

Class MergeDeveloperIdentitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class MergeDeveloperIdentitiesRequest
extends AmazonWebServiceRequest
implements Serializable

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use AWS Developer credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MergeDeveloperIdentitiesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDestinationUserIdentifier() User identifier for the destination user.
String	getDeveloperProviderName() The "domain" by which Cognito will refer to your users.
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
String	getSourceUserIdentifier() User identifier for the source user.
int	hashCode()
void	setDestinationUserIdentifier(String destinationUserIdentifier) User identifier for the destination user.
void	setDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setSourceUserIdentifier(String sourceUserIdentifier) User identifier for the source user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MergeDeveloperIdentitiesRequest	withDestinationUserIdentifier(String destinationUserIdentifier) User identifier for the destination user.
MergeDeveloperIdentitiesRequest	withDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
MergeDeveloperIdentitiesRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
MergeDeveloperIdentitiesRequest	withSourceUserIdentifier(String sourceUserIdentifier) User identifier for the source user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeDeveloperIdentitiesRequest

public MergeDeveloperIdentitiesRequest()

Method Detail

getSourceUserIdentifier

public String getSourceUserIdentifier()

User identifier for the source user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

Returns:

User identifier for the source user. The value should be a DeveloperUserIdentifier.

setSourceUserIdentifier

public void setSourceUserIdentifier(String sourceUserIdentifier)

User identifier for the source user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

Parameters:

sourceUserIdentifier -

User identifier for the source user. The value should be a DeveloperUserIdentifier.

withSourceUserIdentifier

public MergeDeveloperIdentitiesRequest withSourceUserIdentifier(String sourceUserIdentifier)

User identifier for the source user. The value should be a DeveloperUserIdentifier.

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

Constraints:
Length: 1 - 1024

Parameters:

sourceUserIdentifier -

User identifier for the source user. The value should be a DeveloperUserIdentifier.

Returns:

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

getDestinationUserIdentifier

public String getDestinationUserIdentifier()

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

Returns:

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

setDestinationUserIdentifier

public void setDestinationUserIdentifier(String destinationUserIdentifier)

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

Parameters:

destinationUserIdentifier -

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

withDestinationUserIdentifier

public MergeDeveloperIdentitiesRequest withDestinationUserIdentifier(String destinationUserIdentifier)

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

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

Constraints:
Length: 1 - 1024

Parameters:

destinationUserIdentifier -

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

Returns:

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

getDeveloperProviderName

public String getDeveloperProviderName()

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

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

Returns:

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

setDeveloperProviderName

public void setDeveloperProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

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

Parameters:

developerProviderName -

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (.), underscore (_), and dash (-).

withDeveloperProviderName

public MergeDeveloperIdentitiesRequest withDeveloperProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

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

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

Parameters:

developerProviderName -

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (.), underscore (_), and dash (-).

Returns:

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

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
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 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public MergeDeveloperIdentitiesRequest 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 - 55
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.

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