merge_developer_identities¶
Operation¶
merge_developer_identities
¶
merge_developer_identities(request: MergeDeveloperIdentitiesInput | MergeDeveloperIdentitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[MergeDeveloperIdentitiesInputDict]) -> MergeDeveloperIdentitiesOutput
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 Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
MergeDeveloperIdentitiesInput | MergeDeveloperIdentitiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[MergeDeveloperIdentitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
MergeDeveloperIdentitiesOutput
|
An instance of |
merge_developer_identities
async
¶
merge_developer_identities(request: MergeDeveloperIdentitiesInput | MergeDeveloperIdentitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[MergeDeveloperIdentitiesInputDict]) -> MergeDeveloperIdentitiesOutput
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 Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
MergeDeveloperIdentitiesInput | MergeDeveloperIdentitiesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[MergeDeveloperIdentitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
MergeDeveloperIdentitiesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
MergeDeveloperIdentitiesInputDict
¶
Bases: TypedDict
Dictionary form of MergeDeveloperIdentitiesInput.
Attributes¶
destination_user_identifier
instance-attribute
¶
User identifier for the destination user. The value should be a
DeveloperUserIdentifier.
developer_provider_name
instance-attribute
¶
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 (-).
identity_pool_id
instance-attribute
¶
An identity pool ID in the format REGION:GUID.
MergeDeveloperIdentitiesInput
dataclass
¶
Bases: _SerdeShape
Input to the MergeDeveloperIdentities action.
Attributes¶
destination_user_identifier
class-attribute
instance-attribute
¶
destination_user_identifier: str | None = ...
User identifier for the destination user. The value should be a
DeveloperUserIdentifier.
developer_provider_name
class-attribute
instance-attribute
¶
developer_provider_name: str | None = ...
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 (-).
Output¶
MergeDeveloperIdentitiesOutput
dataclass
¶
Bases: _SerdeShape
Returned in response to a successful MergeDeveloperIdentities action.
Attributes¶
identity_id
class-attribute
instance-attribute
¶
identity_id: str | None = ...
A unique identifier in the format REGION:GUID.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.