Amazonka.CustomerProfiles.AddProfileKey

Associates a new key value with a specific profile, such as a Contact Record ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Creating a Request

data AddProfileKey

See: newAddProfileKey smart constructor.

Constructors

AddProfileKey'

Fields

• profileId :: Text

  The unique identifier of a customer profile.

• keyName :: Text

  A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

• values :: [Text]

  A list of key values.

• domainName :: Text

  The unique name of the domain.

Instances

ToJSON AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

toJSON :: AddProfileKey -> Value

toEncoding :: AddProfileKey -> Encoding

toJSONList :: [AddProfileKey] -> Value

toEncodingList :: [AddProfileKey] -> Encoding

ToHeaders AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

toHeaders :: AddProfileKey -> [Header]

ToPath AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

toPath :: AddProfileKey -> ByteString

ToQuery AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

toQuery :: AddProfileKey -> QueryString

AWSRequest AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type AWSResponse AddProfileKey

Methods

request :: (Service -> Service) -> AddProfileKey -> Request AddProfileKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AddProfileKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddProfileKey)))

Generic AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type Rep AddProfileKey :: Type -> Type

Methods

from :: AddProfileKey -> Rep AddProfileKey x

to :: Rep AddProfileKey x -> AddProfileKey

Read AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

readsPrec :: Int -> ReadS AddProfileKey

readList :: ReadS [AddProfileKey]

readPrec :: ReadPrec AddProfileKey

readListPrec :: ReadPrec [AddProfileKey]

Show AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

showsPrec :: Int -> AddProfileKey -> ShowS

show :: AddProfileKey -> String

showList :: [AddProfileKey] -> ShowS

NFData AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

rnf :: AddProfileKey -> ()

Eq AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

(==) :: AddProfileKey -> AddProfileKey -> Bool

(/=) :: AddProfileKey -> AddProfileKey -> Bool

Hashable AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

hashWithSalt :: Int -> AddProfileKey -> Int

hash :: AddProfileKey -> Int

type AWSResponse AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

type AWSResponse AddProfileKey = AddProfileKeyResponse

type Rep AddProfileKey

Defined in Amazonka.CustomerProfiles.AddProfileKey

type Rep AddProfileKey = D1 ('MetaData "AddProfileKey" "Amazonka.CustomerProfiles.AddProfileKey" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "AddProfileKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAddProfileKey

Arguments

:: Text

AddProfileKey

-> Text

AddProfileKey

-> Text

AddProfileKey

-> AddProfileKey

Create a value of AddProfileKey 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:

AddProfileKey, addProfileKey_profileId - The unique identifier of a customer profile.

AddProfileKey, addProfileKey_keyName - A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

AddProfileKey, addProfileKey_values - A list of key values.

AddProfileKey, addProfileKey_domainName - The unique name of the domain.

Request Lenses

addProfileKey_profileId :: Lens' AddProfileKey Text

The unique identifier of a customer profile.

addProfileKey_keyName :: Lens' AddProfileKey Text

A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

addProfileKey_values :: Lens' AddProfileKey [Text]

A list of key values.

addProfileKey_domainName :: Lens' AddProfileKey Text

The unique name of the domain.

Destructuring the Response

data AddProfileKeyResponse

See: newAddProfileKeyResponse smart constructor.

Constructors

AddProfileKeyResponse'

Fields

• keyName :: Maybe Text

  A searchable identifier of a customer profile.

• values :: Maybe [Text]

  A list of key values.

• httpStatus :: Int

  The response's http status code.

Instances

Generic AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type Rep AddProfileKeyResponse :: Type -> Type

Methods

from :: AddProfileKeyResponse -> Rep AddProfileKeyResponse x

to :: Rep AddProfileKeyResponse x -> AddProfileKeyResponse

Read AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

readsPrec :: Int -> ReadS AddProfileKeyResponse

readList :: ReadS [AddProfileKeyResponse]

readPrec :: ReadPrec AddProfileKeyResponse

readListPrec :: ReadPrec [AddProfileKeyResponse]

Show AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

showsPrec :: Int -> AddProfileKeyResponse -> ShowS

show :: AddProfileKeyResponse -> String

showList :: [AddProfileKeyResponse] -> ShowS

NFData AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

rnf :: AddProfileKeyResponse -> ()

Eq AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

(==) :: AddProfileKeyResponse -> AddProfileKeyResponse -> Bool

(/=) :: AddProfileKeyResponse -> AddProfileKeyResponse -> Bool

type Rep AddProfileKeyResponse

Defined in Amazonka.CustomerProfiles.AddProfileKey

type Rep AddProfileKeyResponse = D1 ('MetaData "AddProfileKeyResponse" "Amazonka.CustomerProfiles.AddProfileKey" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "AddProfileKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAddProfileKeyResponse

Arguments

:: Int

$sel:httpStatus:AddProfileKeyResponse'

-> AddProfileKeyResponse

Create a value of AddProfileKeyResponse 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:

AddProfileKey, addProfileKeyResponse_keyName - A searchable identifier of a customer profile.

AddProfileKey, addProfileKeyResponse_values - A list of key values.

$sel:httpStatus:AddProfileKeyResponse', addProfileKeyResponse_httpStatus - The response's http status code.

Response Lenses

addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text)

A searchable identifier of a customer profile.

addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text])

A list of key values.

addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int

The response's http status code.