Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.CognitoIdentity.MergeDeveloperIdentities
Description
Merges two users having different IdentityId
s, 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.
You must use AWS Developer credentials to call this API.
- mergeDeveloperIdentities :: Text -> Text -> Text -> Text -> MergeDeveloperIdentities
- data MergeDeveloperIdentities
- mdiSourceUserIdentifier :: Lens' MergeDeveloperIdentities Text
- mdiDestinationUserIdentifier :: Lens' MergeDeveloperIdentities Text
- mdiDeveloperProviderName :: Lens' MergeDeveloperIdentities Text
- mdiIdentityPoolId :: Lens' MergeDeveloperIdentities Text
- mergeDeveloperIdentitiesResponse :: Int -> MergeDeveloperIdentitiesResponse
- data MergeDeveloperIdentitiesResponse
- mdirsIdentityId :: Lens' MergeDeveloperIdentitiesResponse (Maybe Text)
- mdirsResponseStatus :: Lens' MergeDeveloperIdentitiesResponse Int
Creating a Request
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> MergeDeveloperIdentities |
Creates a value of MergeDeveloperIdentities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdiSourceUserIdentifier
- User identifier for the source user. The value should be aDeveloperUserIdentifier
.mdiDestinationUserIdentifier
- User identifier for the destination user. The value should be aDeveloperUserIdentifier
.mdiDeveloperProviderName
- 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 theDeveloperProviderName
, you can use letters as well as period (.), underscore (_), and dash (-).mdiIdentityPoolId
- An identity pool ID in the format REGION:GUID.
data MergeDeveloperIdentities #
Input to the MergeDeveloperIdentities
action.
See: mergeDeveloperIdentities
smart constructor.
Instances
Request Lenses
mdiSourceUserIdentifier :: Lens' MergeDeveloperIdentities Text #
User identifier for the source user. The value should be a DeveloperUserIdentifier
.
mdiDestinationUserIdentifier :: Lens' MergeDeveloperIdentities Text #
User identifier for the destination user. The value should be a DeveloperUserIdentifier
.
mdiDeveloperProviderName :: Lens' MergeDeveloperIdentities 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 (-).
mdiIdentityPoolId :: Lens' MergeDeveloperIdentities Text #
An identity pool ID in the format REGION:GUID.
Destructuring the Response
mergeDeveloperIdentitiesResponse #
Arguments
:: Int | |
-> MergeDeveloperIdentitiesResponse |
Creates a value of MergeDeveloperIdentitiesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdirsIdentityId
- A unique identifier in the format REGION:GUID.mdirsResponseStatus
- -- | The response status code.
data MergeDeveloperIdentitiesResponse #
Returned in response to a successful MergeDeveloperIdentities
action.
See: mergeDeveloperIdentitiesResponse
smart constructor.
Response Lenses
mdirsIdentityId :: Lens' MergeDeveloperIdentitiesResponse (Maybe Text) #
A unique identifier in the format REGION:GUID.
mdirsResponseStatus :: Lens' MergeDeveloperIdentitiesResponse Int #
- - | The response status code.