Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MergeProfilesCommand

Runs an AWS Lambda job that does the following:

  1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

  2. All the objects in the ProfileToBeMerged will be moved to the main profile.

  3. All the ProfileToBeMerged will be deleted at the end.

  4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

  5. Standard fields are merged as follows:

    1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

    2. When there are conflicting fields:

      1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

      2. If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.

You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).

example

Use a bare-bones client and the command you need to make an API call.

import { CustomerProfilesClient, MergeProfilesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
// const { CustomerProfilesClient, MergeProfilesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
const client = new CustomerProfilesClient(config);
const command = new MergeProfilesCommand(input);
const response = await client.send(command);
see

MergeProfilesCommandInput for command's input shape.

see

MergeProfilesCommandOutput for command's response shape.

see

config for CustomerProfilesClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly input

input: MergeProfilesCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<MergeProfilesCommandInput, MergeProfilesCommandOutput>

Methods

Static getEndpointParameterInstructions