Copyright	(c) 2013-2021 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

Amazonka.CustomerProfiles.MergeProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data MergeProfiles Source #

See: newMergeProfiles smart constructor.

Constructors

MergeProfiles'

Fields

fieldSourceProfileIds :: Maybe FieldSourceProfileIds
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.
domainName :: Text
The unique name of the domain.
mainProfileId :: Text
The identifier of the profile to be taken.
profileIdsToBeMerged :: NonEmpty Text
The identifier of the profile to be merged into MainProfileId.

Instances

Instances details

Eq MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods (==) :: MergeProfiles -> MergeProfiles -> Bool # (/=) :: MergeProfiles -> MergeProfiles -> Bool #
Read MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods readsPrec :: Int -> ReadS MergeProfiles # readList :: ReadS [MergeProfiles] # readPrec :: ReadPrec MergeProfiles # readListPrec :: ReadPrec [MergeProfiles] #
Show MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods showsPrec :: Int -> MergeProfiles -> ShowS # show :: MergeProfiles -> String # showList :: [MergeProfiles] -> ShowS #
Generic MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Associated Types type Rep MergeProfiles :: Type -> Type # Methods from :: MergeProfiles -> Rep MergeProfiles x # to :: Rep MergeProfiles x -> MergeProfiles #
NFData MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods rnf :: MergeProfiles -> () #
Hashable MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods hashWithSalt :: Int -> MergeProfiles -> Int # hash :: MergeProfiles -> Int #
ToJSON MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods toJSON :: MergeProfiles -> Value # toEncoding :: MergeProfiles -> Encoding # toJSONList :: [MergeProfiles] -> Value # toEncodingList :: [MergeProfiles] -> Encoding #
AWSRequest MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Associated Types type AWSResponse MergeProfiles # Methods request :: MergeProfiles -> Request MergeProfiles # response :: MonadResource m => Logger -> Service -> Proxy MergeProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse MergeProfiles))) #
ToHeaders MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods toHeaders :: MergeProfiles -> [Header] #
ToPath MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods toPath :: MergeProfiles -> ByteString #
ToQuery MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods toQuery :: MergeProfiles -> QueryString #
type Rep MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles type Rep MergeProfiles = D1 ('MetaData "MergeProfiles" "Amazonka.CustomerProfiles.MergeProfiles" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "MergeProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fieldSourceProfileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FieldSourceProfileIds)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "mainProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "profileIdsToBeMerged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))
type AWSResponse MergeProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles type AWSResponse MergeProfiles = MergeProfilesResponse

newMergeProfiles Source #

Arguments

:: Text	`$sel:domainName:MergeProfiles'`
-> Text	`$sel:mainProfileId:MergeProfiles'`
-> NonEmpty Text	`$sel:profileIdsToBeMerged:MergeProfiles'`
-> MergeProfiles

Create a value of MergeProfiles 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:fieldSourceProfileIds:MergeProfiles', mergeProfiles_fieldSourceProfileIds - 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.

$sel:domainName:MergeProfiles', mergeProfiles_domainName - The unique name of the domain.

$sel:mainProfileId:MergeProfiles', mergeProfiles_mainProfileId - The identifier of the profile to be taken.

$sel:profileIdsToBeMerged:MergeProfiles', mergeProfiles_profileIdsToBeMerged - The identifier of the profile to be merged into MainProfileId.

Request Lenses

mergeProfiles_fieldSourceProfileIds :: Lens' MergeProfiles (Maybe FieldSourceProfileIds) Source #

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.

mergeProfiles_domainName :: Lens' MergeProfiles Text Source #

The unique name of the domain.

mergeProfiles_mainProfileId :: Lens' MergeProfiles Text Source #

The identifier of the profile to be taken.

mergeProfiles_profileIdsToBeMerged :: Lens' MergeProfiles (NonEmpty Text) Source #

The identifier of the profile to be merged into MainProfileId.

Destructuring the Response

data MergeProfilesResponse Source #

See: newMergeProfilesResponse smart constructor.

Constructors

MergeProfilesResponse'
Fields message :: Maybe Text A message that indicates the merge request is complete. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods (==) :: MergeProfilesResponse -> MergeProfilesResponse -> Bool # (/=) :: MergeProfilesResponse -> MergeProfilesResponse -> Bool #
Read MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods readsPrec :: Int -> ReadS MergeProfilesResponse # readList :: ReadS [MergeProfilesResponse] # readPrec :: ReadPrec MergeProfilesResponse # readListPrec :: ReadPrec [MergeProfilesResponse] #
Show MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods showsPrec :: Int -> MergeProfilesResponse -> ShowS # show :: MergeProfilesResponse -> String # showList :: [MergeProfilesResponse] -> ShowS #
Generic MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Associated Types type Rep MergeProfilesResponse :: Type -> Type # Methods from :: MergeProfilesResponse -> Rep MergeProfilesResponse x # to :: Rep MergeProfilesResponse x -> MergeProfilesResponse #
NFData MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles Methods rnf :: MergeProfilesResponse -> () #
type Rep MergeProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.MergeProfiles type Rep MergeProfilesResponse = D1 ('MetaData "MergeProfilesResponse" "Amazonka.CustomerProfiles.MergeProfiles" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "MergeProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newMergeProfilesResponse Source #

Arguments

:: Int	`$sel:httpStatus:MergeProfilesResponse'`
-> MergeProfilesResponse

Create a value of MergeProfilesResponse 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:message:MergeProfilesResponse', mergeProfilesResponse_message - A message that indicates the merge request is complete.

$sel:httpStatus:MergeProfilesResponse', mergeProfilesResponse_httpStatus - The response's http status code.

Response Lenses

mergeProfilesResponse_message :: Lens' MergeProfilesResponse (Maybe Text) Source #

A message that indicates the merge request is complete.

mergeProfilesResponse_httpStatus :: Lens' MergeProfilesResponse Int Source #

The response's http status code.