[ aws . customer-profiles ]

merge-profiles

Description

This API is in preview release for Amazon Connect and subject to change.

Runs an AWS Lambda job that does the following:

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

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

• All the ProfileToBeMerged will be deleted at the end.

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

• Standard fields are merged as follows:

  • Fields are always “union”-ed if there are no conflicts in standard fields or attributeKeys.

  • When there are conflicting fields:

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

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  merge-profiles
--domain-name <value>
--main-profile-id <value>
--profile-ids-to-be-merged <value>
[--field-source-profile-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The unique name of the domain.

--main-profile-id (string)

The identifier of the profile to be taken.

--profile-ids-to-be-merged (list)

The identifier of the profile to be merged into MainProfileId.

(string)

Syntax:

"string" "string" ...

--field-source-profile-ids (structure)

The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.

AccountNumber -> (string)

A unique identifier for the account number field to be merged.

AdditionalInformation -> (string)

A unique identifier for the additional information field to be merged.

PartyType -> (string)

A unique identifier for the party type field to be merged.

BusinessName -> (string)

A unique identifier for the business name field to be merged.

FirstName -> (string)

A unique identifier for the first name field to be merged.

MiddleName -> (string)

A unique identifier for the middle name field to be merged.

LastName -> (string)

A unique identifier for the last name field to be merged.

BirthDate -> (string)

A unique identifier for the birthdate field to be merged.

Gender -> (string)

A unique identifier for the gender field to be merged.

PhoneNumber -> (string)

A unique identifier for the phone number field to be merged.

MobilePhoneNumber -> (string)

A unique identifier for the mobile phone number field to be merged.

HomePhoneNumber -> (string)

A unique identifier for the home phone number field to be merged.

BusinessPhoneNumber -> (string)

A unique identifier for the business phone number field to be merged.

EmailAddress -> (string)

A unique identifier for the email address field to be merged.

PersonalEmailAddress -> (string)

A unique identifier for the personal email address field to be merged.

BusinessEmailAddress -> (string)

A unique identifier for the party type field to be merged.

Address -> (string)

A unique identifier for the party type field to be merged.

ShippingAddress -> (string)

A unique identifier for the shipping address field to be merged.

MailingAddress -> (string)

A unique identifier for the mailing address field to be merged.

BillingAddress -> (string)

A unique identifier for the billing type field to be merged.

Attributes -> (map)

A unique identifier for the attributes field to be merged.

key -> (string)

value -> (string)

Shorthand Syntax:

AccountNumber=string,AdditionalInformation=string,PartyType=string,BusinessName=string,FirstName=string,MiddleName=string,LastName=string,BirthDate=string,Gender=string,PhoneNumber=string,MobilePhoneNumber=string,HomePhoneNumber=string,BusinessPhoneNumber=string,EmailAddress=string,PersonalEmailAddress=string,BusinessEmailAddress=string,Address=string,ShippingAddress=string,MailingAddress=string,BillingAddress=string,Attributes={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "AccountNumber": "string",
  "AdditionalInformation": "string",
  "PartyType": "string",
  "BusinessName": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "BirthDate": "string",
  "Gender": "string",
  "PhoneNumber": "string",
  "MobilePhoneNumber": "string",
  "HomePhoneNumber": "string",
  "BusinessPhoneNumber": "string",
  "EmailAddress": "string",
  "PersonalEmailAddress": "string",
  "BusinessEmailAddress": "string",
  "Address": "string",
  "ShippingAddress": "string",
  "MailingAddress": "string",
  "BillingAddress": "string",
  "Attributes": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Message -> (string)

A message that indicates the merge request is complete.