AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginMergeDeveloperIdentities and EndMergeDeveloperIdentities.

Namespace: Amazon.CognitoIdentity
Assembly: AWSSDK.CognitoIdentity.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<MergeDeveloperIdentitiesResponse> MergeDeveloperIdentitiesAsync(
         MergeDeveloperIdentitiesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest

Container for the necessary parameters to execute the MergeDeveloperIdentities service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the MergeDeveloperIdentities service method, as returned by CognitoIdentity.

Exceptions

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also