amazonka-cognito-identity-2.0: Amazon Cognito Identity SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CognitoIdentity.MergeDeveloperIdentities

Description

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.

Synopsis

Creating a Request

data MergeDeveloperIdentities Source #

Input to the MergeDeveloperIdentities action.

See: newMergeDeveloperIdentities smart constructor.

Constructors

MergeDeveloperIdentities' 

Fields

  • sourceUserIdentifier :: Text

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

  • destinationUserIdentifier :: Text

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

  • developerProviderName :: Text

    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 (-).

  • identityPoolId :: Text

    An identity pool ID in the format REGION:GUID.

Instances

Instances details
ToJSON MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

ToHeaders MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

ToPath MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

ToQuery MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

AWSRequest MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Generic MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Associated Types

type Rep MergeDeveloperIdentities :: Type -> Type #

Read MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Show MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

NFData MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Eq MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Hashable MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

type AWSResponse MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

type Rep MergeDeveloperIdentities Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

type Rep MergeDeveloperIdentities = D1 ('MetaData "MergeDeveloperIdentities" "Amazonka.CognitoIdentity.MergeDeveloperIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "MergeDeveloperIdentities'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceUserIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationUserIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "developerProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMergeDeveloperIdentities Source #

Create a value of MergeDeveloperIdentities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceUserIdentifier:MergeDeveloperIdentities', mergeDeveloperIdentities_sourceUserIdentifier - User identifier for the source user. The value should be a DeveloperUserIdentifier.

$sel:destinationUserIdentifier:MergeDeveloperIdentities', mergeDeveloperIdentities_destinationUserIdentifier - User identifier for the destination user. The value should be a DeveloperUserIdentifier.

MergeDeveloperIdentities, mergeDeveloperIdentities_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 (-).

MergeDeveloperIdentities, mergeDeveloperIdentities_identityPoolId - An identity pool ID in the format REGION:GUID.

Request Lenses

mergeDeveloperIdentities_sourceUserIdentifier :: Lens' MergeDeveloperIdentities Text Source #

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

mergeDeveloperIdentities_destinationUserIdentifier :: Lens' MergeDeveloperIdentities Text Source #

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

mergeDeveloperIdentities_developerProviderName :: Lens' MergeDeveloperIdentities Text Source #

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 (-).

mergeDeveloperIdentities_identityPoolId :: Lens' MergeDeveloperIdentities Text Source #

An identity pool ID in the format REGION:GUID.

Destructuring the Response

data MergeDeveloperIdentitiesResponse Source #

Returned in response to a successful MergeDeveloperIdentities action.

See: newMergeDeveloperIdentitiesResponse smart constructor.

Constructors

MergeDeveloperIdentitiesResponse' 

Fields

Instances

Instances details
Generic MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Associated Types

type Rep MergeDeveloperIdentitiesResponse :: Type -> Type #

Read MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Show MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

NFData MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

Eq MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

type Rep MergeDeveloperIdentitiesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.MergeDeveloperIdentities

type Rep MergeDeveloperIdentitiesResponse = D1 ('MetaData "MergeDeveloperIdentitiesResponse" "Amazonka.CognitoIdentity.MergeDeveloperIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "MergeDeveloperIdentitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newMergeDeveloperIdentitiesResponse Source #

Create a value of MergeDeveloperIdentitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

MergeDeveloperIdentitiesResponse, mergeDeveloperIdentitiesResponse_identityId - A unique identifier in the format REGION:GUID.

$sel:httpStatus:MergeDeveloperIdentitiesResponse', mergeDeveloperIdentitiesResponse_httpStatus - The response's http status code.

Response Lenses