| 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.Lens
Contents
- Operations
- DeleteProfileObjectType
- ListIntegrations
- PutProfileObjectType
- ListProfileObjects
- ListProfileObjectTypeTemplates
- DeleteProfile
- UpdateProfile
- ListTagsForResource
- AddProfileKey
- GetProfileObjectTypeTemplate
- GetIntegration
- GetDomain
- CreateDomain
- DeleteIntegration
- CreateProfile
- PutProfileObject
- PutIntegration
- DeleteProfileObject
- ListProfileObjectTypes
- DeleteProfileKey
- GetProfileObjectType
- MergeProfiles
- TagResource
- GetMatches
- UntagResource
- SearchProfiles
- ListAccountIntegrations
- DeleteDomain
- UpdateDomain
- ListDomains
- Types
- Address
- ConnectorOperator
- DomainStats
- FieldSourceProfileIds
- FlowDefinition
- IncrementalPullConfig
- ListDomainItem
- ListIntegrationItem
- ListProfileObjectTypeItem
- ListProfileObjectTypeTemplateItem
- ListProfileObjectsItem
- MarketoSourceProperties
- MatchItem
- MatchingRequest
- MatchingResponse
- ObjectFilter
- ObjectTypeField
- ObjectTypeKey
- Profile
- S3SourceProperties
- SalesforceSourceProperties
- ScheduledTriggerProperties
- ServiceNowSourceProperties
- SourceConnectorProperties
- SourceFlowConfig
- Task
- TriggerConfig
- TriggerProperties
- UpdateAddress
- ZendeskSourceProperties
Description
Synopsis
- deleteProfileObjectType_domainName :: Lens' DeleteProfileObjectType Text
- deleteProfileObjectType_objectTypeName :: Lens' DeleteProfileObjectType Text
- deleteProfileObjectTypeResponse_httpStatus :: Lens' DeleteProfileObjectTypeResponse Int
- deleteProfileObjectTypeResponse_message :: Lens' DeleteProfileObjectTypeResponse Text
- listIntegrations_nextToken :: Lens' ListIntegrations (Maybe Text)
- listIntegrations_maxResults :: Lens' ListIntegrations (Maybe Natural)
- listIntegrations_domainName :: Lens' ListIntegrations Text
- listIntegrationsResponse_items :: Lens' ListIntegrationsResponse (Maybe [ListIntegrationItem])
- listIntegrationsResponse_nextToken :: Lens' ListIntegrationsResponse (Maybe Text)
- listIntegrationsResponse_httpStatus :: Lens' ListIntegrationsResponse Int
- putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural)
- putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text)
- putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey]))
- putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text)
- putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (Maybe Bool)
- putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField))
- putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text))
- putProfileObjectType_domainName :: Lens' PutProfileObjectType Text
- putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text
- putProfileObjectType_description :: Lens' PutProfileObjectType Text
- putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural)
- putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
- putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
- putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text)
- putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey]))
- putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text)
- putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (Maybe Bool)
- putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField))
- putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text))
- putProfileObjectTypeResponse_httpStatus :: Lens' PutProfileObjectTypeResponse Int
- putProfileObjectTypeResponse_objectTypeName :: Lens' PutProfileObjectTypeResponse Text
- putProfileObjectTypeResponse_description :: Lens' PutProfileObjectTypeResponse Text
- listProfileObjects_objectFilter :: Lens' ListProfileObjects (Maybe ObjectFilter)
- listProfileObjects_nextToken :: Lens' ListProfileObjects (Maybe Text)
- listProfileObjects_maxResults :: Lens' ListProfileObjects (Maybe Natural)
- listProfileObjects_domainName :: Lens' ListProfileObjects Text
- listProfileObjects_objectTypeName :: Lens' ListProfileObjects Text
- listProfileObjects_profileId :: Lens' ListProfileObjects Text
- listProfileObjectsResponse_items :: Lens' ListProfileObjectsResponse (Maybe [ListProfileObjectsItem])
- listProfileObjectsResponse_nextToken :: Lens' ListProfileObjectsResponse (Maybe Text)
- listProfileObjectsResponse_httpStatus :: Lens' ListProfileObjectsResponse Int
- listProfileObjectTypeTemplates_nextToken :: Lens' ListProfileObjectTypeTemplates (Maybe Text)
- listProfileObjectTypeTemplates_maxResults :: Lens' ListProfileObjectTypeTemplates (Maybe Natural)
- listProfileObjectTypeTemplatesResponse_items :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe [ListProfileObjectTypeTemplateItem])
- listProfileObjectTypeTemplatesResponse_nextToken :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe Text)
- listProfileObjectTypeTemplatesResponse_httpStatus :: Lens' ListProfileObjectTypeTemplatesResponse Int
- deleteProfile_profileId :: Lens' DeleteProfile Text
- deleteProfile_domainName :: Lens' DeleteProfile Text
- deleteProfileResponse_message :: Lens' DeleteProfileResponse (Maybe Text)
- deleteProfileResponse_httpStatus :: Lens' DeleteProfileResponse Int
- updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_middleName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_lastName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text)
- updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType)
- updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text))
- updateProfile_gender :: Lens' UpdateProfile (Maybe Gender)
- updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_firstName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text)
- updateProfile_businessName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_domainName :: Lens' UpdateProfile Text
- updateProfile_profileId :: Lens' UpdateProfile Text
- updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int
- updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- addProfileKey_profileId :: Lens' AddProfileKey Text
- addProfileKey_keyName :: Lens' AddProfileKey Text
- addProfileKey_values :: Lens' AddProfileKey [Text]
- addProfileKey_domainName :: Lens' AddProfileKey Text
- addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text])
- addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text)
- addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int
- getProfileObjectTypeTemplate_templateId :: Lens' GetProfileObjectTypeTemplate Text
- getProfileObjectTypeTemplateResponse_sourceName :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text)
- getProfileObjectTypeTemplateResponse_templateId :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text)
- getProfileObjectTypeTemplateResponse_sourceObject :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text)
- getProfileObjectTypeTemplateResponse_keys :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text [ObjectTypeKey]))
- getProfileObjectTypeTemplateResponse_allowProfileCreation :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Bool)
- getProfileObjectTypeTemplateResponse_fields :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text ObjectTypeField))
- getProfileObjectTypeTemplateResponse_httpStatus :: Lens' GetProfileObjectTypeTemplateResponse Int
- getIntegration_domainName :: Lens' GetIntegration Text
- getIntegration_uri :: Lens' GetIntegration Text
- getIntegrationResponse_tags :: Lens' GetIntegrationResponse (Maybe (HashMap Text Text))
- getIntegrationResponse_httpStatus :: Lens' GetIntegrationResponse Int
- getIntegrationResponse_domainName :: Lens' GetIntegrationResponse Text
- getIntegrationResponse_uri :: Lens' GetIntegrationResponse Text
- getIntegrationResponse_objectTypeName :: Lens' GetIntegrationResponse Text
- getIntegrationResponse_createdAt :: Lens' GetIntegrationResponse UTCTime
- getIntegrationResponse_lastUpdatedAt :: Lens' GetIntegrationResponse UTCTime
- getDomain_domainName :: Lens' GetDomain Text
- getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural)
- getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (Maybe Text)
- getDomainResponse_matching :: Lens' GetDomainResponse (Maybe MatchingResponse)
- getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats)
- getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (Maybe Text)
- getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text))
- getDomainResponse_httpStatus :: Lens' GetDomainResponse Int
- getDomainResponse_domainName :: Lens' GetDomainResponse Text
- getDomainResponse_createdAt :: Lens' GetDomainResponse UTCTime
- getDomainResponse_lastUpdatedAt :: Lens' GetDomainResponse UTCTime
- createDomain_defaultEncryptionKey :: Lens' CreateDomain (Maybe Text)
- createDomain_matching :: Lens' CreateDomain (Maybe MatchingRequest)
- createDomain_deadLetterQueueUrl :: Lens' CreateDomain (Maybe Text)
- createDomain_tags :: Lens' CreateDomain (Maybe (HashMap Text Text))
- createDomain_domainName :: Lens' CreateDomain Text
- createDomain_defaultExpirationDays :: Lens' CreateDomain Natural
- createDomainResponse_defaultEncryptionKey :: Lens' CreateDomainResponse (Maybe Text)
- createDomainResponse_matching :: Lens' CreateDomainResponse (Maybe MatchingResponse)
- createDomainResponse_deadLetterQueueUrl :: Lens' CreateDomainResponse (Maybe Text)
- createDomainResponse_tags :: Lens' CreateDomainResponse (Maybe (HashMap Text Text))
- createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
- createDomainResponse_domainName :: Lens' CreateDomainResponse Text
- createDomainResponse_defaultExpirationDays :: Lens' CreateDomainResponse Natural
- createDomainResponse_createdAt :: Lens' CreateDomainResponse UTCTime
- createDomainResponse_lastUpdatedAt :: Lens' CreateDomainResponse UTCTime
- deleteIntegration_domainName :: Lens' DeleteIntegration Text
- deleteIntegration_uri :: Lens' DeleteIntegration Text
- deleteIntegrationResponse_httpStatus :: Lens' DeleteIntegrationResponse Int
- deleteIntegrationResponse_message :: Lens' DeleteIntegrationResponse Text
- createProfile_shippingAddress :: Lens' CreateProfile (Maybe Address)
- createProfile_mobilePhoneNumber :: Lens' CreateProfile (Maybe Text)
- createProfile_mailingAddress :: Lens' CreateProfile (Maybe Address)
- createProfile_middleName :: Lens' CreateProfile (Maybe Text)
- createProfile_personalEmailAddress :: Lens' CreateProfile (Maybe Text)
- createProfile_lastName :: Lens' CreateProfile (Maybe Text)
- createProfile_additionalInformation :: Lens' CreateProfile (Maybe Text)
- createProfile_homePhoneNumber :: Lens' CreateProfile (Maybe Text)
- createProfile_address :: Lens' CreateProfile (Maybe Address)
- createProfile_partyType :: Lens' CreateProfile (Maybe PartyType)
- createProfile_businessEmailAddress :: Lens' CreateProfile (Maybe Text)
- createProfile_attributes :: Lens' CreateProfile (Maybe (HashMap Text Text))
- createProfile_gender :: Lens' CreateProfile (Maybe Gender)
- createProfile_phoneNumber :: Lens' CreateProfile (Maybe Text)
- createProfile_accountNumber :: Lens' CreateProfile (Maybe Text)
- createProfile_emailAddress :: Lens' CreateProfile (Maybe Text)
- createProfile_firstName :: Lens' CreateProfile (Maybe Text)
- createProfile_billingAddress :: Lens' CreateProfile (Maybe Address)
- createProfile_businessPhoneNumber :: Lens' CreateProfile (Maybe Text)
- createProfile_birthDate :: Lens' CreateProfile (Maybe Text)
- createProfile_businessName :: Lens' CreateProfile (Maybe Text)
- createProfile_domainName :: Lens' CreateProfile Text
- createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int
- createProfileResponse_profileId :: Lens' CreateProfileResponse Text
- putProfileObject_objectTypeName :: Lens' PutProfileObject Text
- putProfileObject_object :: Lens' PutProfileObject Text
- putProfileObject_domainName :: Lens' PutProfileObject Text
- putProfileObjectResponse_profileObjectUniqueKey :: Lens' PutProfileObjectResponse (Maybe Text)
- putProfileObjectResponse_httpStatus :: Lens' PutProfileObjectResponse Int
- putIntegration_flowDefinition :: Lens' PutIntegration (Maybe FlowDefinition)
- putIntegration_uri :: Lens' PutIntegration (Maybe Text)
- putIntegration_tags :: Lens' PutIntegration (Maybe (HashMap Text Text))
- putIntegration_domainName :: Lens' PutIntegration Text
- putIntegration_objectTypeName :: Lens' PutIntegration Text
- putIntegrationResponse_tags :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))
- putIntegrationResponse_httpStatus :: Lens' PutIntegrationResponse Int
- putIntegrationResponse_domainName :: Lens' PutIntegrationResponse Text
- putIntegrationResponse_uri :: Lens' PutIntegrationResponse Text
- putIntegrationResponse_objectTypeName :: Lens' PutIntegrationResponse Text
- putIntegrationResponse_createdAt :: Lens' PutIntegrationResponse UTCTime
- putIntegrationResponse_lastUpdatedAt :: Lens' PutIntegrationResponse UTCTime
- deleteProfileObject_profileId :: Lens' DeleteProfileObject Text
- deleteProfileObject_profileObjectUniqueKey :: Lens' DeleteProfileObject Text
- deleteProfileObject_objectTypeName :: Lens' DeleteProfileObject Text
- deleteProfileObject_domainName :: Lens' DeleteProfileObject Text
- deleteProfileObjectResponse_message :: Lens' DeleteProfileObjectResponse (Maybe Text)
- deleteProfileObjectResponse_httpStatus :: Lens' DeleteProfileObjectResponse Int
- listProfileObjectTypes_nextToken :: Lens' ListProfileObjectTypes (Maybe Text)
- listProfileObjectTypes_maxResults :: Lens' ListProfileObjectTypes (Maybe Natural)
- listProfileObjectTypes_domainName :: Lens' ListProfileObjectTypes Text
- listProfileObjectTypesResponse_items :: Lens' ListProfileObjectTypesResponse (Maybe [ListProfileObjectTypeItem])
- listProfileObjectTypesResponse_nextToken :: Lens' ListProfileObjectTypesResponse (Maybe Text)
- listProfileObjectTypesResponse_httpStatus :: Lens' ListProfileObjectTypesResponse Int
- deleteProfileKey_profileId :: Lens' DeleteProfileKey Text
- deleteProfileKey_keyName :: Lens' DeleteProfileKey Text
- deleteProfileKey_values :: Lens' DeleteProfileKey [Text]
- deleteProfileKey_domainName :: Lens' DeleteProfileKey Text
- deleteProfileKeyResponse_message :: Lens' DeleteProfileKeyResponse (Maybe Text)
- deleteProfileKeyResponse_httpStatus :: Lens' DeleteProfileKeyResponse Int
- getProfileObjectType_domainName :: Lens' GetProfileObjectType Text
- getProfileObjectType_objectTypeName :: Lens' GetProfileObjectType Text
- getProfileObjectTypeResponse_expirationDays :: Lens' GetProfileObjectTypeResponse (Maybe Natural)
- getProfileObjectTypeResponse_lastUpdatedAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime)
- getProfileObjectTypeResponse_createdAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime)
- getProfileObjectTypeResponse_templateId :: Lens' GetProfileObjectTypeResponse (Maybe Text)
- getProfileObjectTypeResponse_keys :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey]))
- getProfileObjectTypeResponse_encryptionKey :: Lens' GetProfileObjectTypeResponse (Maybe Text)
- getProfileObjectTypeResponse_allowProfileCreation :: Lens' GetProfileObjectTypeResponse (Maybe Bool)
- getProfileObjectTypeResponse_fields :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField))
- getProfileObjectTypeResponse_tags :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text Text))
- getProfileObjectTypeResponse_httpStatus :: Lens' GetProfileObjectTypeResponse Int
- getProfileObjectTypeResponse_objectTypeName :: Lens' GetProfileObjectTypeResponse Text
- getProfileObjectTypeResponse_description :: Lens' GetProfileObjectTypeResponse Text
- mergeProfiles_fieldSourceProfileIds :: Lens' MergeProfiles (Maybe FieldSourceProfileIds)
- mergeProfiles_domainName :: Lens' MergeProfiles Text
- mergeProfiles_mainProfileId :: Lens' MergeProfiles Text
- mergeProfiles_profileIdsToBeMerged :: Lens' MergeProfiles (NonEmpty Text)
- mergeProfilesResponse_message :: Lens' MergeProfilesResponse (Maybe Text)
- mergeProfilesResponse_httpStatus :: Lens' MergeProfilesResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- getMatches_nextToken :: Lens' GetMatches (Maybe Text)
- getMatches_maxResults :: Lens' GetMatches (Maybe Natural)
- getMatches_domainName :: Lens' GetMatches Text
- getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem])
- getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime)
- getMatchesResponse_nextToken :: Lens' GetMatchesResponse (Maybe Text)
- getMatchesResponse_potentialMatches :: Lens' GetMatchesResponse (Maybe Natural)
- getMatchesResponse_httpStatus :: Lens' GetMatchesResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text)
- searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural)
- searchProfiles_domainName :: Lens' SearchProfiles Text
- searchProfiles_keyName :: Lens' SearchProfiles Text
- searchProfiles_values :: Lens' SearchProfiles [Text]
- searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile])
- searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text)
- searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int
- listAccountIntegrations_nextToken :: Lens' ListAccountIntegrations (Maybe Text)
- listAccountIntegrations_maxResults :: Lens' ListAccountIntegrations (Maybe Natural)
- listAccountIntegrations_uri :: Lens' ListAccountIntegrations Text
- listAccountIntegrationsResponse_items :: Lens' ListAccountIntegrationsResponse (Maybe [ListIntegrationItem])
- listAccountIntegrationsResponse_nextToken :: Lens' ListAccountIntegrationsResponse (Maybe Text)
- listAccountIntegrationsResponse_httpStatus :: Lens' ListAccountIntegrationsResponse Int
- deleteDomain_domainName :: Lens' DeleteDomain Text
- deleteDomainResponse_httpStatus :: Lens' DeleteDomainResponse Int
- deleteDomainResponse_message :: Lens' DeleteDomainResponse Text
- updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural)
- updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text)
- updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest)
- updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text)
- updateDomain_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text))
- updateDomain_domainName :: Lens' UpdateDomain Text
- updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural)
- updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text)
- updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse)
- updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text)
- updateDomainResponse_tags :: Lens' UpdateDomainResponse (Maybe (HashMap Text Text))
- updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int
- updateDomainResponse_domainName :: Lens' UpdateDomainResponse Text
- updateDomainResponse_createdAt :: Lens' UpdateDomainResponse UTCTime
- updateDomainResponse_lastUpdatedAt :: Lens' UpdateDomainResponse UTCTime
- listDomains_nextToken :: Lens' ListDomains (Maybe Text)
- listDomains_maxResults :: Lens' ListDomains (Maybe Natural)
- listDomainsResponse_items :: Lens' ListDomainsResponse (Maybe [ListDomainItem])
- listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text)
- listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int
- address_address2 :: Lens' Address (Maybe Text)
- address_state :: Lens' Address (Maybe Text)
- address_address4 :: Lens' Address (Maybe Text)
- address_county :: Lens' Address (Maybe Text)
- address_address3 :: Lens' Address (Maybe Text)
- address_postalCode :: Lens' Address (Maybe Text)
- address_country :: Lens' Address (Maybe Text)
- address_city :: Lens' Address (Maybe Text)
- address_address1 :: Lens' Address (Maybe Text)
- address_province :: Lens' Address (Maybe Text)
- connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator)
- connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator)
- connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator)
- connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator)
- connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator)
- domainStats_meteringProfileCount :: Lens' DomainStats (Maybe Integer)
- domainStats_totalSize :: Lens' DomainStats (Maybe Integer)
- domainStats_profileCount :: Lens' DomainStats (Maybe Integer)
- domainStats_objectCount :: Lens' DomainStats (Maybe Integer)
- fieldSourceProfileIds_shippingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_mobilePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_mailingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_middleName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_personalEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_lastName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_additionalInformation :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_homePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_address :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_partyType :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_attributes :: Lens' FieldSourceProfileIds (Maybe (HashMap Text Text))
- fieldSourceProfileIds_gender :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_phoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_accountNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_emailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_firstName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_billingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessPhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_birthDate :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessName :: Lens' FieldSourceProfileIds (Maybe Text)
- flowDefinition_description :: Lens' FlowDefinition (Maybe Text)
- flowDefinition_flowName :: Lens' FlowDefinition Text
- flowDefinition_kmsArn :: Lens' FlowDefinition Text
- flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig
- flowDefinition_tasks :: Lens' FlowDefinition [Task]
- flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig
- incrementalPullConfig_datetimeTypeFieldName :: Lens' IncrementalPullConfig (Maybe Text)
- listDomainItem_tags :: Lens' ListDomainItem (Maybe (HashMap Text Text))
- listDomainItem_domainName :: Lens' ListDomainItem Text
- listDomainItem_createdAt :: Lens' ListDomainItem UTCTime
- listDomainItem_lastUpdatedAt :: Lens' ListDomainItem UTCTime
- listIntegrationItem_tags :: Lens' ListIntegrationItem (Maybe (HashMap Text Text))
- listIntegrationItem_domainName :: Lens' ListIntegrationItem Text
- listIntegrationItem_uri :: Lens' ListIntegrationItem Text
- listIntegrationItem_objectTypeName :: Lens' ListIntegrationItem Text
- listIntegrationItem_createdAt :: Lens' ListIntegrationItem UTCTime
- listIntegrationItem_lastUpdatedAt :: Lens' ListIntegrationItem UTCTime
- listProfileObjectTypeItem_lastUpdatedAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime)
- listProfileObjectTypeItem_createdAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime)
- listProfileObjectTypeItem_tags :: Lens' ListProfileObjectTypeItem (Maybe (HashMap Text Text))
- listProfileObjectTypeItem_objectTypeName :: Lens' ListProfileObjectTypeItem Text
- listProfileObjectTypeItem_description :: Lens' ListProfileObjectTypeItem Text
- listProfileObjectTypeTemplateItem_sourceName :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- listProfileObjectTypeTemplateItem_templateId :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- listProfileObjectTypeTemplateItem_sourceObject :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- listProfileObjectsItem_profileObjectUniqueKey :: Lens' ListProfileObjectsItem (Maybe Text)
- listProfileObjectsItem_objectTypeName :: Lens' ListProfileObjectsItem (Maybe Text)
- listProfileObjectsItem_object :: Lens' ListProfileObjectsItem (Maybe Text)
- marketoSourceProperties_object :: Lens' MarketoSourceProperties Text
- matchItem_profileIds :: Lens' MatchItem (Maybe [Text])
- matchItem_matchId :: Lens' MatchItem (Maybe Text)
- matchingRequest_enabled :: Lens' MatchingRequest Bool
- matchingResponse_enabled :: Lens' MatchingResponse (Maybe Bool)
- objectFilter_keyName :: Lens' ObjectFilter Text
- objectFilter_values :: Lens' ObjectFilter [Text]
- objectTypeField_source :: Lens' ObjectTypeField (Maybe Text)
- objectTypeField_contentType :: Lens' ObjectTypeField (Maybe FieldContentType)
- objectTypeField_target :: Lens' ObjectTypeField (Maybe Text)
- objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text])
- objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier])
- profile_shippingAddress :: Lens' Profile (Maybe Address)
- profile_mobilePhoneNumber :: Lens' Profile (Maybe Text)
- profile_mailingAddress :: Lens' Profile (Maybe Address)
- profile_middleName :: Lens' Profile (Maybe Text)
- profile_personalEmailAddress :: Lens' Profile (Maybe Text)
- profile_lastName :: Lens' Profile (Maybe Text)
- profile_additionalInformation :: Lens' Profile (Maybe Text)
- profile_homePhoneNumber :: Lens' Profile (Maybe Text)
- profile_address :: Lens' Profile (Maybe Address)
- profile_partyType :: Lens' Profile (Maybe PartyType)
- profile_profileId :: Lens' Profile (Maybe Text)
- profile_businessEmailAddress :: Lens' Profile (Maybe Text)
- profile_attributes :: Lens' Profile (Maybe (HashMap Text Text))
- profile_gender :: Lens' Profile (Maybe Gender)
- profile_phoneNumber :: Lens' Profile (Maybe Text)
- profile_accountNumber :: Lens' Profile (Maybe Text)
- profile_emailAddress :: Lens' Profile (Maybe Text)
- profile_firstName :: Lens' Profile (Maybe Text)
- profile_billingAddress :: Lens' Profile (Maybe Address)
- profile_businessPhoneNumber :: Lens' Profile (Maybe Text)
- profile_birthDate :: Lens' Profile (Maybe Text)
- profile_businessName :: Lens' Profile (Maybe Text)
- s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text)
- s3SourceProperties_bucketName :: Lens' S3SourceProperties Text
- salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool)
- salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool)
- salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text
- scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural)
- scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode)
- scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text)
- scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text
- serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text
- sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties)
- sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties)
- sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties)
- sourceConnectorProperties_zendesk :: Lens' SourceConnectorProperties (Maybe ZendeskSourceProperties)
- sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties)
- sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text)
- sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig)
- sourceFlowConfig_connectorType :: Lens' SourceFlowConfig SourceConnectorType
- sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties
- task_taskProperties :: Lens' Task (Maybe (HashMap OperatorPropertiesKeys Text))
- task_connectorOperator :: Lens' Task (Maybe ConnectorOperator)
- task_destinationField :: Lens' Task (Maybe Text)
- task_sourceFields :: Lens' Task [Text]
- task_taskType :: Lens' Task TaskType
- triggerConfig_triggerProperties :: Lens' TriggerConfig (Maybe TriggerProperties)
- triggerConfig_triggerType :: Lens' TriggerConfig TriggerType
- triggerProperties_scheduled :: Lens' TriggerProperties (Maybe ScheduledTriggerProperties)
- updateAddress_address2 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_state :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address4 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_county :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address3 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_postalCode :: Lens' UpdateAddress (Maybe Text)
- updateAddress_country :: Lens' UpdateAddress (Maybe Text)
- updateAddress_city :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address1 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_province :: Lens' UpdateAddress (Maybe Text)
- zendeskSourceProperties_object :: Lens' ZendeskSourceProperties Text
Operations
DeleteProfileObjectType
deleteProfileObjectType_domainName :: Lens' DeleteProfileObjectType Text Source #
The unique name of the domain.
deleteProfileObjectType_objectTypeName :: Lens' DeleteProfileObjectType Text Source #
The name of the profile object type.
deleteProfileObjectTypeResponse_httpStatus :: Lens' DeleteProfileObjectTypeResponse Int Source #
The response's http status code.
deleteProfileObjectTypeResponse_message :: Lens' DeleteProfileObjectTypeResponse Text Source #
A message that indicates the delete request is done.
ListIntegrations
listIntegrations_nextToken :: Lens' ListIntegrations (Maybe Text) Source #
The pagination token from the previous ListIntegrations API call.
listIntegrations_maxResults :: Lens' ListIntegrations (Maybe Natural) Source #
The maximum number of objects returned per page.
listIntegrations_domainName :: Lens' ListIntegrations Text Source #
The unique name of the domain.
listIntegrationsResponse_items :: Lens' ListIntegrationsResponse (Maybe [ListIntegrationItem]) Source #
The list of ListIntegrations instances.
listIntegrationsResponse_nextToken :: Lens' ListIntegrationsResponse (Maybe Text) Source #
The pagination token from the previous ListIntegrations API call.
listIntegrationsResponse_httpStatus :: Lens' ListIntegrationsResponse Int Source #
The response's http status code.
PutProfileObjectType
putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural) Source #
The number of days until the data in the object expires.
putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text) Source #
A unique identifier for the object template.
putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey])) Source #
A list of unique keys that can be used to map data to the profile.
putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text) Source #
The customer-provided key to encrypt the profile object that will be created in this profile object type.
putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (Maybe Bool) Source #
Indicates whether a profile should be created when data is received if
one doesn’t exist for an object of this type. The default is FALSE. If
the AllowProfileCreation flag is set to FALSE, then the service tries
to fetch a standard profile and associate this object with the profile.
If it is set to TRUE, and if no match is found, then the service
creates a new standard profile.
putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putProfileObjectType_domainName :: Lens' PutProfileObjectType Text Source #
The unique name of the domain.
putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text Source #
The name of the profile object type.
putProfileObjectType_description :: Lens' PutProfileObjectType Text Source #
Description of the profile object type.
putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural) Source #
The number of days until the data in the object expires.
putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was most recently edited.
putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was created.
putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #
A unique identifier for the object template.
putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #
A list of unique keys that can be used to map data to the profile.
putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #
The customer-provided key to encrypt the profile object that will be created in this profile object type.
putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (Maybe Bool) Source #
Indicates whether a profile should be created when data is received if
one doesn’t exist for an object of this type. The default is FALSE. If
the AllowProfileCreation flag is set to FALSE, then the service tries
to fetch a standard profile and associate this object with the profile.
If it is set to TRUE, and if no match is found, then the service
creates a new standard profile.
putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putProfileObjectTypeResponse_httpStatus :: Lens' PutProfileObjectTypeResponse Int Source #
The response's http status code.
putProfileObjectTypeResponse_objectTypeName :: Lens' PutProfileObjectTypeResponse Text Source #
The name of the profile object type.
putProfileObjectTypeResponse_description :: Lens' PutProfileObjectTypeResponse Text Source #
Description of the profile object type.
ListProfileObjects
listProfileObjects_objectFilter :: Lens' ListProfileObjects (Maybe ObjectFilter) Source #
Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset and _case.
listProfileObjects_nextToken :: Lens' ListProfileObjects (Maybe Text) Source #
The pagination token from the previous call to ListProfileObjects.
listProfileObjects_maxResults :: Lens' ListProfileObjects (Maybe Natural) Source #
The maximum number of objects returned per page.
listProfileObjects_domainName :: Lens' ListProfileObjects Text Source #
The unique name of the domain.
listProfileObjects_objectTypeName :: Lens' ListProfileObjects Text Source #
The name of the profile object type.
listProfileObjects_profileId :: Lens' ListProfileObjects Text Source #
The unique identifier of a customer profile.
listProfileObjectsResponse_items :: Lens' ListProfileObjectsResponse (Maybe [ListProfileObjectsItem]) Source #
The list of ListProfileObject instances.
listProfileObjectsResponse_nextToken :: Lens' ListProfileObjectsResponse (Maybe Text) Source #
The pagination token from the previous call to ListProfileObjects.
listProfileObjectsResponse_httpStatus :: Lens' ListProfileObjectsResponse Int Source #
The response's http status code.
ListProfileObjectTypeTemplates
listProfileObjectTypeTemplates_nextToken :: Lens' ListProfileObjectTypeTemplates (Maybe Text) Source #
The pagination token from the previous ListObjectTypeTemplates API call.
listProfileObjectTypeTemplates_maxResults :: Lens' ListProfileObjectTypeTemplates (Maybe Natural) Source #
The maximum number of objects returned per page.
listProfileObjectTypeTemplatesResponse_items :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe [ListProfileObjectTypeTemplateItem]) Source #
The list of ListProfileObjectType template instances.
listProfileObjectTypeTemplatesResponse_nextToken :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe Text) Source #
The pagination token from the previous ListObjectTypeTemplates API call.
listProfileObjectTypeTemplatesResponse_httpStatus :: Lens' ListProfileObjectTypeTemplatesResponse Int Source #
The response's http status code.
DeleteProfile
deleteProfile_profileId :: Lens' DeleteProfile Text Source #
The unique identifier of a customer profile.
deleteProfile_domainName :: Lens' DeleteProfile Text Source #
The unique name of the domain.
deleteProfileResponse_message :: Lens' DeleteProfileResponse (Maybe Text) Source #
A message that indicates the delete request is done.
deleteProfileResponse_httpStatus :: Lens' DeleteProfileResponse Int Source #
The response's http status code.
UpdateProfile
updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s shipping address.
updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s mobile phone number.
updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s mailing address.
updateProfile_middleName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s middle name.
updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s personal email address.
updateProfile_lastName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s last name.
updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text) Source #
Any additional information relevant to the customer’s profile.
updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s home phone number.
updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
A generic address associated with the customer that is not mailing, shipping, or billing.
updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType) Source #
The type of profile used to describe the customer.
updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s business email address.
updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text)) Source #
A key value pair of attributes of a customer profile.
updateProfile_gender :: Lens' UpdateProfile (Maybe Gender) Source #
The gender with which the customer identifies.
updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s phone number, which has not been specified as a mobile, home, or business number.
updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text) Source #
A unique account number that you have given to the customer.
updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s email address, which has not been specified as a personal or business address.
updateProfile_firstName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s first name.
updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s billing address.
updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s business phone number.
updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s birth date.
updateProfile_businessName :: Lens' UpdateProfile (Maybe Text) Source #
The name of the customer’s business.
updateProfile_domainName :: Lens' UpdateProfile Text Source #
The unique name of the domain.
updateProfile_profileId :: Lens' UpdateProfile Text Source #
The unique identifier of a customer profile.
updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int Source #
The response's http status code.
updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text Source #
The unique identifier of a customer profile.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource for which you want to view tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
AddProfileKey
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.
addProfileKey_values :: Lens' AddProfileKey [Text] Source #
A list of key values.
addProfileKey_domainName :: Lens' AddProfileKey Text Source #
The unique name of the domain.
addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text]) Source #
A list of key values.
addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text) Source #
A searchable identifier of a customer profile.
addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int Source #
The response's http status code.
GetProfileObjectTypeTemplate
getProfileObjectTypeTemplate_templateId :: Lens' GetProfileObjectTypeTemplate Text Source #
A unique identifier for the object template.
getProfileObjectTypeTemplateResponse_sourceName :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #
The name of the source of the object template.
getProfileObjectTypeTemplateResponse_templateId :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #
A unique identifier for the object template.
getProfileObjectTypeTemplateResponse_sourceObject :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #
The source of the object template.
getProfileObjectTypeTemplateResponse_keys :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #
A list of unique keys that can be used to map data to the profile.
getProfileObjectTypeTemplateResponse_allowProfileCreation :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Bool) Source #
Indicates whether a profile should be created when data is received if
one doesn’t exist for an object of this type. The default is FALSE. If
the AllowProfileCreation flag is set to FALSE, then the service tries
to fetch a standard profile and associate this object with the profile.
If it is set to TRUE, and if no match is found, then the service
creates a new standard profile.
getProfileObjectTypeTemplateResponse_fields :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
getProfileObjectTypeTemplateResponse_httpStatus :: Lens' GetProfileObjectTypeTemplateResponse Int Source #
The response's http status code.
GetIntegration
getIntegration_domainName :: Lens' GetIntegration Text Source #
The unique name of the domain.
getIntegration_uri :: Lens' GetIntegration Text Source #
The URI of the S3 bucket or any other type of data source.
getIntegrationResponse_tags :: Lens' GetIntegrationResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
getIntegrationResponse_httpStatus :: Lens' GetIntegrationResponse Int Source #
The response's http status code.
getIntegrationResponse_domainName :: Lens' GetIntegrationResponse Text Source #
The unique name of the domain.
getIntegrationResponse_uri :: Lens' GetIntegrationResponse Text Source #
The URI of the S3 bucket or any other type of data source.
getIntegrationResponse_objectTypeName :: Lens' GetIntegrationResponse Text Source #
The name of the profile object type.
getIntegrationResponse_createdAt :: Lens' GetIntegrationResponse UTCTime Source #
The timestamp of when the domain was created.
getIntegrationResponse_lastUpdatedAt :: Lens' GetIntegrationResponse UTCTime Source #
The timestamp of when the domain was most recently edited.
GetDomain
getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural) Source #
The default number of days until the data within the domain expires.
getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (Maybe Text) Source #
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
getDomainResponse_matching :: Lens' GetDomainResponse (Maybe MatchingResponse) Source #
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats) Source #
Usage-specific statistics about the domain.
getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (Maybe Text) Source #
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #
The response's http status code.
getDomainResponse_domainName :: Lens' GetDomainResponse Text Source #
The unique name of the domain.
getDomainResponse_createdAt :: Lens' GetDomainResponse UTCTime Source #
The timestamp of when the domain was created.
getDomainResponse_lastUpdatedAt :: Lens' GetDomainResponse UTCTime Source #
The timestamp of when the domain was most recently edited.
CreateDomain
createDomain_defaultEncryptionKey :: Lens' CreateDomain (Maybe Text) Source #
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
createDomain_matching :: Lens' CreateDomain (Maybe MatchingRequest) Source #
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
createDomain_deadLetterQueueUrl :: Lens' CreateDomain (Maybe Text) Source #
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
createDomain_tags :: Lens' CreateDomain (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
createDomain_domainName :: Lens' CreateDomain Text Source #
The unique name of the domain.
createDomain_defaultExpirationDays :: Lens' CreateDomain Natural Source #
The default number of days until the data within the domain expires.
createDomainResponse_defaultEncryptionKey :: Lens' CreateDomainResponse (Maybe Text) Source #
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
createDomainResponse_matching :: Lens' CreateDomainResponse (Maybe MatchingResponse) Source #
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
createDomainResponse_deadLetterQueueUrl :: Lens' CreateDomainResponse (Maybe Text) Source #
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
createDomainResponse_tags :: Lens' CreateDomainResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #
The response's http status code.
createDomainResponse_domainName :: Lens' CreateDomainResponse Text Source #
The unique name of the domain.
createDomainResponse_defaultExpirationDays :: Lens' CreateDomainResponse Natural Source #
The default number of days until the data within the domain expires.
createDomainResponse_createdAt :: Lens' CreateDomainResponse UTCTime Source #
The timestamp of when the domain was created.
createDomainResponse_lastUpdatedAt :: Lens' CreateDomainResponse UTCTime Source #
The timestamp of when the domain was most recently edited.
DeleteIntegration
deleteIntegration_domainName :: Lens' DeleteIntegration Text Source #
The unique name of the domain.
deleteIntegration_uri :: Lens' DeleteIntegration Text Source #
The URI of the S3 bucket or any other type of data source.
deleteIntegrationResponse_httpStatus :: Lens' DeleteIntegrationResponse Int Source #
The response's http status code.
deleteIntegrationResponse_message :: Lens' DeleteIntegrationResponse Text Source #
A message that indicates the delete request is done.
CreateProfile
createProfile_shippingAddress :: Lens' CreateProfile (Maybe Address) Source #
The customer’s shipping address.
createProfile_mobilePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #
The customer’s mobile phone number.
createProfile_mailingAddress :: Lens' CreateProfile (Maybe Address) Source #
The customer’s mailing address.
createProfile_middleName :: Lens' CreateProfile (Maybe Text) Source #
The customer’s middle name.
createProfile_personalEmailAddress :: Lens' CreateProfile (Maybe Text) Source #
The customer’s personal email address.
createProfile_lastName :: Lens' CreateProfile (Maybe Text) Source #
The customer’s last name.
createProfile_additionalInformation :: Lens' CreateProfile (Maybe Text) Source #
Any additional information relevant to the customer’s profile.
createProfile_homePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #
The customer’s home phone number.
createProfile_address :: Lens' CreateProfile (Maybe Address) Source #
A generic address associated with the customer that is not mailing, shipping, or billing.
createProfile_partyType :: Lens' CreateProfile (Maybe PartyType) Source #
The type of profile used to describe the customer.
createProfile_businessEmailAddress :: Lens' CreateProfile (Maybe Text) Source #
The customer’s business email address.
createProfile_attributes :: Lens' CreateProfile (Maybe (HashMap Text Text)) Source #
A key value pair of attributes of a customer profile.
createProfile_gender :: Lens' CreateProfile (Maybe Gender) Source #
The gender with which the customer identifies.
createProfile_phoneNumber :: Lens' CreateProfile (Maybe Text) Source #
The customer’s phone number, which has not been specified as a mobile, home, or business number.
createProfile_accountNumber :: Lens' CreateProfile (Maybe Text) Source #
A unique account number that you have given to the customer.
createProfile_emailAddress :: Lens' CreateProfile (Maybe Text) Source #
The customer’s email address, which has not been specified as a personal or business address.
createProfile_firstName :: Lens' CreateProfile (Maybe Text) Source #
The customer’s first name.
createProfile_billingAddress :: Lens' CreateProfile (Maybe Address) Source #
The customer’s billing address.
createProfile_businessPhoneNumber :: Lens' CreateProfile (Maybe Text) Source #
The customer’s business phone number.
createProfile_birthDate :: Lens' CreateProfile (Maybe Text) Source #
The customer’s birth date.
createProfile_businessName :: Lens' CreateProfile (Maybe Text) Source #
The name of the customer’s business.
createProfile_domainName :: Lens' CreateProfile Text Source #
The unique name of the domain.
createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #
The response's http status code.
createProfileResponse_profileId :: Lens' CreateProfileResponse Text Source #
The unique identifier of a customer profile.
PutProfileObject
putProfileObject_objectTypeName :: Lens' PutProfileObject Text Source #
The name of the profile object type.
putProfileObject_object :: Lens' PutProfileObject Text Source #
A string that is serialized from a JSON object.
putProfileObject_domainName :: Lens' PutProfileObject Text Source #
The unique name of the domain.
putProfileObjectResponse_profileObjectUniqueKey :: Lens' PutProfileObjectResponse (Maybe Text) Source #
The unique identifier of the profile object generated by the service.
putProfileObjectResponse_httpStatus :: Lens' PutProfileObjectResponse Int Source #
The response's http status code.
PutIntegration
putIntegration_flowDefinition :: Lens' PutIntegration (Maybe FlowDefinition) Source #
The configuration that controls how Customer Profiles retrieves data from the source.
putIntegration_uri :: Lens' PutIntegration (Maybe Text) Source #
The URI of the S3 bucket or any other type of data source.
putIntegration_tags :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putIntegration_domainName :: Lens' PutIntegration Text Source #
The unique name of the domain.
putIntegration_objectTypeName :: Lens' PutIntegration Text Source #
The name of the profile object type.
putIntegrationResponse_tags :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putIntegrationResponse_httpStatus :: Lens' PutIntegrationResponse Int Source #
The response's http status code.
putIntegrationResponse_domainName :: Lens' PutIntegrationResponse Text Source #
The unique name of the domain.
putIntegrationResponse_uri :: Lens' PutIntegrationResponse Text Source #
The URI of the S3 bucket or any other type of data source.
putIntegrationResponse_objectTypeName :: Lens' PutIntegrationResponse Text Source #
The name of the profile object type.
putIntegrationResponse_createdAt :: Lens' PutIntegrationResponse UTCTime Source #
The timestamp of when the domain was created.
putIntegrationResponse_lastUpdatedAt :: Lens' PutIntegrationResponse UTCTime Source #
The timestamp of when the domain was most recently edited.
DeleteProfileObject
deleteProfileObject_profileId :: Lens' DeleteProfileObject Text Source #
The unique identifier of a customer profile.
deleteProfileObject_profileObjectUniqueKey :: Lens' DeleteProfileObject Text Source #
The unique identifier of the profile object generated by the service.
deleteProfileObject_objectTypeName :: Lens' DeleteProfileObject Text Source #
The name of the profile object type.
deleteProfileObject_domainName :: Lens' DeleteProfileObject Text Source #
The unique name of the domain.
deleteProfileObjectResponse_message :: Lens' DeleteProfileObjectResponse (Maybe Text) Source #
A message that indicates the delete request is done.
deleteProfileObjectResponse_httpStatus :: Lens' DeleteProfileObjectResponse Int Source #
The response's http status code.
ListProfileObjectTypes
listProfileObjectTypes_nextToken :: Lens' ListProfileObjectTypes (Maybe Text) Source #
Identifies the next page of results to return.
listProfileObjectTypes_maxResults :: Lens' ListProfileObjectTypes (Maybe Natural) Source #
The maximum number of objects returned per page.
listProfileObjectTypes_domainName :: Lens' ListProfileObjectTypes Text Source #
The unique name of the domain.
listProfileObjectTypesResponse_items :: Lens' ListProfileObjectTypesResponse (Maybe [ListProfileObjectTypeItem]) Source #
The list of ListProfileObjectTypes instances.
listProfileObjectTypesResponse_nextToken :: Lens' ListProfileObjectTypesResponse (Maybe Text) Source #
Identifies the next page of results to return.
listProfileObjectTypesResponse_httpStatus :: Lens' ListProfileObjectTypesResponse Int Source #
The response's http status code.
DeleteProfileKey
deleteProfileKey_profileId :: Lens' DeleteProfileKey Text Source #
The unique identifier of a customer profile.
deleteProfileKey_keyName :: Lens' DeleteProfileKey Text Source #
A searchable identifier of a customer profile.
deleteProfileKey_values :: Lens' DeleteProfileKey [Text] Source #
A list of key values.
deleteProfileKey_domainName :: Lens' DeleteProfileKey Text Source #
The unique name of the domain.
deleteProfileKeyResponse_message :: Lens' DeleteProfileKeyResponse (Maybe Text) Source #
A message that indicates the delete request is done.
deleteProfileKeyResponse_httpStatus :: Lens' DeleteProfileKeyResponse Int Source #
The response's http status code.
GetProfileObjectType
getProfileObjectType_domainName :: Lens' GetProfileObjectType Text Source #
The unique name of the domain.
getProfileObjectType_objectTypeName :: Lens' GetProfileObjectType Text Source #
The name of the profile object type.
getProfileObjectTypeResponse_expirationDays :: Lens' GetProfileObjectTypeResponse (Maybe Natural) Source #
The number of days until the data in the object expires.
getProfileObjectTypeResponse_lastUpdatedAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was most recently edited.
getProfileObjectTypeResponse_createdAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was created.
getProfileObjectTypeResponse_templateId :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #
A unique identifier for the object template.
getProfileObjectTypeResponse_keys :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #
A list of unique keys that can be used to map data to the profile.
getProfileObjectTypeResponse_encryptionKey :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #
The customer-provided key to encrypt the profile object that will be created in this profile object type.
getProfileObjectTypeResponse_allowProfileCreation :: Lens' GetProfileObjectTypeResponse (Maybe Bool) Source #
Indicates whether a profile should be created when data is received if
one doesn’t exist for an object of this type. The default is FALSE. If
the AllowProfileCreation flag is set to FALSE, then the service tries
to fetch a standard profile and associate this object with the profile.
If it is set to TRUE, and if no match is found, then the service
creates a new standard profile.
getProfileObjectTypeResponse_fields :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
getProfileObjectTypeResponse_tags :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
getProfileObjectTypeResponse_httpStatus :: Lens' GetProfileObjectTypeResponse Int Source #
The response's http status code.
getProfileObjectTypeResponse_objectTypeName :: Lens' GetProfileObjectTypeResponse Text Source #
The name of the profile object type.
getProfileObjectTypeResponse_description :: Lens' GetProfileObjectTypeResponse Text Source #
The description of the profile object type.
MergeProfiles
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.
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.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the resource that you're adding tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The tags used to organize, track, or control access for this resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
GetMatches
getMatches_nextToken :: Lens' GetMatches (Maybe Text) Source #
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
getMatches_maxResults :: Lens' GetMatches (Maybe Natural) Source #
The maximum number of results to return per page.
getMatches_domainName :: Lens' GetMatches Text Source #
The unique name of the domain.
getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem]) Source #
The list of matched profiles for this instance.
getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime) Source #
The timestamp this version of Match Result generated.
getMatchesResponse_nextToken :: Lens' GetMatchesResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
getMatchesResponse_potentialMatches :: Lens' GetMatchesResponse (Maybe Natural) Source #
The number of potential matches found.
getMatchesResponse_httpStatus :: Lens' GetMatchesResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the resource from which you are removing tags.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The list of tag keys to remove from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
SearchProfiles
searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text) Source #
The pagination token from the previous SearchProfiles API call.
searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural) Source #
The maximum number of objects returned per page.
searchProfiles_domainName :: Lens' SearchProfiles Text Source #
The unique name of the domain.
searchProfiles_keyName :: Lens' SearchProfiles Text Source #
A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.
searchProfiles_values :: Lens' SearchProfiles [Text] Source #
A list of key values.
searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile]) Source #
The list of SearchProfiles instances.
searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text) Source #
The pagination token from the previous SearchProfiles API call.
searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int Source #
The response's http status code.
ListAccountIntegrations
listAccountIntegrations_nextToken :: Lens' ListAccountIntegrations (Maybe Text) Source #
The pagination token from the previous ListAccountIntegrations API call.
listAccountIntegrations_maxResults :: Lens' ListAccountIntegrations (Maybe Natural) Source #
The maximum number of objects returned per page.
listAccountIntegrations_uri :: Lens' ListAccountIntegrations Text Source #
The URI of the S3 bucket or any other type of data source.
listAccountIntegrationsResponse_items :: Lens' ListAccountIntegrationsResponse (Maybe [ListIntegrationItem]) Source #
The list of ListAccountIntegration instances.
listAccountIntegrationsResponse_nextToken :: Lens' ListAccountIntegrationsResponse (Maybe Text) Source #
The pagination token from the previous ListAccountIntegrations API call.
listAccountIntegrationsResponse_httpStatus :: Lens' ListAccountIntegrationsResponse Int Source #
The response's http status code.
DeleteDomain
deleteDomain_domainName :: Lens' DeleteDomain Text Source #
The unique name of the domain.
deleteDomainResponse_httpStatus :: Lens' DeleteDomainResponse Int Source #
The response's http status code.
deleteDomainResponse_message :: Lens' DeleteDomainResponse Text Source #
A message that indicates the delete request is done.
UpdateDomain
updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural) Source #
The default number of days until the data within the domain expires.
updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text) Source #
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest) Source #
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text) Source #
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
updateDomain_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
updateDomain_domainName :: Lens' UpdateDomain Text Source #
The unique name of the domain.
updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural) Source #
The default number of days until the data within the domain expires.
updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text) Source #
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse) Source #
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text) Source #
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
updateDomainResponse_tags :: Lens' UpdateDomainResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #
The response's http status code.
updateDomainResponse_domainName :: Lens' UpdateDomainResponse Text Source #
The unique name of the domain.
updateDomainResponse_createdAt :: Lens' UpdateDomainResponse UTCTime Source #
The timestamp of when the domain was created.
updateDomainResponse_lastUpdatedAt :: Lens' UpdateDomainResponse UTCTime Source #
The timestamp of when the domain was most recently edited.
ListDomains
listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #
The pagination token from the previous ListDomain API call.
listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #
The maximum number of objects returned per page.
listDomainsResponse_items :: Lens' ListDomainsResponse (Maybe [ListDomainItem]) Source #
The list of ListDomains instances.
listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #
The pagination token from the previous ListDomains API call.
listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #
The response's http status code.
Types
Address
ConnectorOperator
connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator) Source #
The operation to be performed on the provided ServiceNow source fields.
connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator) Source #
The operation to be performed on the provided Marketo source fields.
connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator) Source #
The operation to be performed on the provided Salesforce source fields.
connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator) Source #
The operation to be performed on the provided Zendesk source fields.
connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator) Source #
The operation to be performed on the provided Amazon S3 source fields.
DomainStats
domainStats_meteringProfileCount :: Lens' DomainStats (Maybe Integer) Source #
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
domainStats_totalSize :: Lens' DomainStats (Maybe Integer) Source #
The total size, in bytes, of all objects in the domain.
domainStats_profileCount :: Lens' DomainStats (Maybe Integer) Source #
The total number of profiles currently in the domain.
domainStats_objectCount :: Lens' DomainStats (Maybe Integer) Source #
The total number of objects in domain.
FieldSourceProfileIds
fieldSourceProfileIds_shippingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the shipping address field to be merged.
fieldSourceProfileIds_mobilePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the mobile phone number field to be merged.
fieldSourceProfileIds_mailingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the mailing address field to be merged.
fieldSourceProfileIds_middleName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the middle name field to be merged.
fieldSourceProfileIds_personalEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the personal email address field to be merged.
fieldSourceProfileIds_lastName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the last name field to be merged.
fieldSourceProfileIds_additionalInformation :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the additional information field to be merged.
fieldSourceProfileIds_homePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the home phone number field to be merged.
fieldSourceProfileIds_address :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_partyType :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_businessEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_attributes :: Lens' FieldSourceProfileIds (Maybe (HashMap Text Text)) Source #
A unique identifier for the attributes field to be merged.
fieldSourceProfileIds_gender :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the gender field to be merged.
fieldSourceProfileIds_phoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the phone number field to be merged.
fieldSourceProfileIds_accountNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the account number field to be merged.
fieldSourceProfileIds_emailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the email address field to be merged.
fieldSourceProfileIds_firstName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the first name field to be merged.
fieldSourceProfileIds_billingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the billing type field to be merged.
fieldSourceProfileIds_businessPhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the business phone number field to be merged.
fieldSourceProfileIds_birthDate :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the birthdate field to be merged.
fieldSourceProfileIds_businessName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the business name field to be merged.
FlowDefinition
flowDefinition_description :: Lens' FlowDefinition (Maybe Text) Source #
A description of the flow you want to create.
flowDefinition_flowName :: Lens' FlowDefinition Text Source #
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
flowDefinition_kmsArn :: Lens' FlowDefinition Text Source #
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig Source #
The configuration that controls how Customer Profiles retrieves data from the source.
flowDefinition_tasks :: Lens' FlowDefinition [Task] Source #
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig Source #
The trigger settings that determine how and when the flow runs.
IncrementalPullConfig
incrementalPullConfig_datetimeTypeFieldName :: Lens' IncrementalPullConfig (Maybe Text) Source #
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
ListDomainItem
listDomainItem_tags :: Lens' ListDomainItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listDomainItem_domainName :: Lens' ListDomainItem Text Source #
The unique name of the domain.
listDomainItem_createdAt :: Lens' ListDomainItem UTCTime Source #
The timestamp of when the domain was created.
listDomainItem_lastUpdatedAt :: Lens' ListDomainItem UTCTime Source #
The timestamp of when the domain was most recently edited.
ListIntegrationItem
listIntegrationItem_tags :: Lens' ListIntegrationItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listIntegrationItem_domainName :: Lens' ListIntegrationItem Text Source #
The unique name of the domain.
listIntegrationItem_uri :: Lens' ListIntegrationItem Text Source #
The URI of the S3 bucket or any other type of data source.
listIntegrationItem_objectTypeName :: Lens' ListIntegrationItem Text Source #
The name of the profile object type.
listIntegrationItem_createdAt :: Lens' ListIntegrationItem UTCTime Source #
The timestamp of when the domain was created.
listIntegrationItem_lastUpdatedAt :: Lens' ListIntegrationItem UTCTime Source #
The timestamp of when the domain was most recently edited.
ListProfileObjectTypeItem
listProfileObjectTypeItem_lastUpdatedAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #
The timestamp of when the domain was most recently edited.
listProfileObjectTypeItem_createdAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #
The timestamp of when the domain was created.
listProfileObjectTypeItem_tags :: Lens' ListProfileObjectTypeItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listProfileObjectTypeItem_objectTypeName :: Lens' ListProfileObjectTypeItem Text Source #
The name of the profile object type.
listProfileObjectTypeItem_description :: Lens' ListProfileObjectTypeItem Text Source #
Description of the profile object type.
ListProfileObjectTypeTemplateItem
listProfileObjectTypeTemplateItem_sourceName :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
The name of the source of the object template.
listProfileObjectTypeTemplateItem_templateId :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
A unique identifier for the object template.
listProfileObjectTypeTemplateItem_sourceObject :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
The source of the object template.
ListProfileObjectsItem
listProfileObjectsItem_profileObjectUniqueKey :: Lens' ListProfileObjectsItem (Maybe Text) Source #
The unique identifier of the ProfileObject generated by the service.
listProfileObjectsItem_objectTypeName :: Lens' ListProfileObjectsItem (Maybe Text) Source #
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
listProfileObjectsItem_object :: Lens' ListProfileObjectsItem (Maybe Text) Source #
A JSON representation of a ProfileObject that belongs to a profile.
MarketoSourceProperties
marketoSourceProperties_object :: Lens' MarketoSourceProperties Text Source #
The object specified in the Marketo flow source.
MatchItem
matchItem_profileIds :: Lens' MatchItem (Maybe [Text]) Source #
A list of identifiers for profiles that match.
matchItem_matchId :: Lens' MatchItem (Maybe Text) Source #
The unique identifiers for this group of profiles that match.
MatchingRequest
matchingRequest_enabled :: Lens' MatchingRequest Bool Source #
The flag that enables the matching process of duplicate profiles.
MatchingResponse
matchingResponse_enabled :: Lens' MatchingResponse (Maybe Bool) Source #
The flag that enables the matching process of duplicate profiles.
ObjectFilter
objectFilter_keyName :: Lens' ObjectFilter Text Source #
A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId.
objectFilter_values :: Lens' ObjectFilter [Text] Source #
A list of key values.
ObjectTypeField
objectTypeField_source :: Lens' ObjectTypeField (Maybe Text) Source #
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
objectTypeField_contentType :: Lens' ObjectTypeField (Maybe FieldContentType) Source #
The content type of the field. Used for determining equality when searching.
objectTypeField_target :: Lens' ObjectTypeField (Maybe Text) Source #
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ObjectTypeKey
objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text]) Source #
The reference for the key name of the fields map.
objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier]) Source #
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
Profile
profile_personalEmailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s personal email address.
profile_additionalInformation :: Lens' Profile (Maybe Text) Source #
Any additional information relevant to the customer’s profile.
profile_address :: Lens' Profile (Maybe Address) Source #
A generic address associated with the customer that is not mailing, shipping, or billing.
profile_partyType :: Lens' Profile (Maybe PartyType) Source #
The type of profile used to describe the customer.
profile_profileId :: Lens' Profile (Maybe Text) Source #
The unique identifier of a customer profile.
profile_businessEmailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s business email address.
profile_attributes :: Lens' Profile (Maybe (HashMap Text Text)) Source #
A key value pair of attributes of a customer profile.
profile_gender :: Lens' Profile (Maybe Gender) Source #
The gender with which the customer identifies.
profile_phoneNumber :: Lens' Profile (Maybe Text) Source #
The customer's phone number, which has not been specified as a mobile, home, or business number.
profile_accountNumber :: Lens' Profile (Maybe Text) Source #
A unique account number that you have given to the customer.
profile_emailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s email address, which has not been specified as a personal or business address.
S3SourceProperties
s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text) Source #
The object key for the Amazon S3 bucket in which the source files are stored.
s3SourceProperties_bucketName :: Lens' S3SourceProperties Text Source #
The Amazon S3 bucket name where the source files are stored.
SalesforceSourceProperties
salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool) Source #
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool) Source #
Indicates whether Amazon AppFlow includes deleted files in the flow run.
salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text Source #
The object specified in the Salesforce flow source.
ScheduledTriggerProperties
scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the scheduled end time for a scheduled-trigger flow.
scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural) Source #
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode) Source #
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the scheduled start time for a scheduled-trigger flow.
scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text) Source #
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the date range for the records to import from the connector in the first flow run.
scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text Source #
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
ServiceNowSourceProperties
serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text Source #
The object specified in the ServiceNow flow source.
SourceConnectorProperties
sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties) Source #
The properties that are applied when ServiceNow is being used as a source.
sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties) Source #
The properties that are applied when Marketo is being used as a source.
sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties) Source #
The properties that are applied when Salesforce is being used as a source.
sourceConnectorProperties_zendesk :: Lens' SourceConnectorProperties (Maybe ZendeskSourceProperties) Source #
The properties that are applied when using Zendesk as a flow source.
sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties) Source #
The properties that are applied when Amazon S3 is being used as the flow source.
SourceFlowConfig
sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text) Source #
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig) Source #
Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
sourceFlowConfig_connectorType :: Lens' SourceFlowConfig SourceConnectorType Source #
The type of connector, such as Salesforce, Marketo, and so on.
sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties Source #
Specifies the information that is required to query a particular source connector.
Task
task_taskProperties :: Lens' Task (Maybe (HashMap OperatorPropertiesKeys Text)) Source #
A map used to store task-related information. The service looks for particular information based on the TaskType.
task_connectorOperator :: Lens' Task (Maybe ConnectorOperator) Source #
The operation to be performed on the provided source fields.
task_destinationField :: Lens' Task (Maybe Text) Source #
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
task_sourceFields :: Lens' Task [Text] Source #
The source fields to which a particular task is applied.
task_taskType :: Lens' Task TaskType Source #
Specifies the particular task implementation that Amazon AppFlow performs.
TriggerConfig
triggerConfig_triggerProperties :: Lens' TriggerConfig (Maybe TriggerProperties) Source #
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
triggerConfig_triggerType :: Lens' TriggerConfig TriggerType Source #
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
TriggerProperties
triggerProperties_scheduled :: Lens' TriggerProperties (Maybe ScheduledTriggerProperties) Source #
Specifies the configuration details of a schedule-triggered flow that you define.
UpdateAddress
updateAddress_address2 :: Lens' UpdateAddress (Maybe Text) Source #
The second line of a customer address.
updateAddress_state :: Lens' UpdateAddress (Maybe Text) Source #
The state in which a customer lives.
updateAddress_address4 :: Lens' UpdateAddress (Maybe Text) Source #
The fourth line of a customer address.
updateAddress_county :: Lens' UpdateAddress (Maybe Text) Source #
The county in which a customer lives.
updateAddress_address3 :: Lens' UpdateAddress (Maybe Text) Source #
The third line of a customer address.
updateAddress_postalCode :: Lens' UpdateAddress (Maybe Text) Source #
The postal code of a customer address.
updateAddress_country :: Lens' UpdateAddress (Maybe Text) Source #
The country in which a customer lives.
updateAddress_city :: Lens' UpdateAddress (Maybe Text) Source #
The city in which a customer lives.
updateAddress_address1 :: Lens' UpdateAddress (Maybe Text) Source #
The first line of a customer address.
updateAddress_province :: Lens' UpdateAddress (Maybe Text) Source #
The province in which a customer lives.
ZendeskSourceProperties
zendeskSourceProperties_object :: Lens' ZendeskSourceProperties Text Source #
The object specified in the Zendesk flow source.