amazonka-customer-profiles-2.0: Amazon Connect Customer Profiles SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CustomerProfiles.AddProfileKey

Description

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.

Synopsis

Creating a Request

data AddProfileKey Source #

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

Instances details
ToJSON AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

ToHeaders AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

ToPath AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

ToQuery AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

AWSRequest AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type AWSResponse AddProfileKey #

Generic AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type Rep AddProfileKey :: Type -> Type #

Read AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Show AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

NFData AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

rnf :: AddProfileKey -> () #

Eq AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Hashable AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

type AWSResponse AddProfileKey Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

type Rep AddProfileKey Source # 
Instance details

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 Source #

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 Source #

The unique identifier of a customer profile.

addProfileKey_keyName :: Lens' AddProfileKey Text Source #

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_domainName :: Lens' AddProfileKey Text Source #

The unique name of the domain.

Destructuring the Response

data AddProfileKeyResponse Source #

See: newAddProfileKeyResponse smart constructor.

Constructors

AddProfileKeyResponse' 

Fields

Instances

Instances details
Generic AddProfileKeyResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Associated Types

type Rep AddProfileKeyResponse :: Type -> Type #

Read AddProfileKeyResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Show AddProfileKeyResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

NFData AddProfileKeyResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

Methods

rnf :: AddProfileKeyResponse -> () #

Eq AddProfileKeyResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.AddProfileKey

type Rep AddProfileKeyResponse Source # 
Instance details

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 Source #

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) Source #

A searchable identifier of a customer profile.