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 |
- Service Configuration
- Errors
- Waiters
- 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
- DataPullMode
- FieldContentType
- Gender
- MarketoConnectorOperator
- OperatorPropertiesKeys
- PartyType
- S3ConnectorOperator
- SalesforceConnectorOperator
- ServiceNowConnectorOperator
- SourceConnectorType
- StandardIdentifier
- TaskType
- TriggerType
- ZendeskConnectorOperator
- 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
Derived from API version 2020-08-15
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Connect Customer Profiles
Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.
Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
If you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data DeleteProfileObjectType = DeleteProfileObjectType' Text Text
- newDeleteProfileObjectType :: Text -> Text -> DeleteProfileObjectType
- data DeleteProfileObjectTypeResponse = DeleteProfileObjectTypeResponse' Int Text
- newDeleteProfileObjectTypeResponse :: Int -> Text -> DeleteProfileObjectTypeResponse
- data ListIntegrations = ListIntegrations' (Maybe Text) (Maybe Natural) Text
- newListIntegrations :: Text -> ListIntegrations
- data ListIntegrationsResponse = ListIntegrationsResponse' (Maybe [ListIntegrationItem]) (Maybe Text) Int
- newListIntegrationsResponse :: Int -> ListIntegrationsResponse
- data PutProfileObjectType = PutProfileObjectType' (Maybe Natural) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Text Text Text
- newPutProfileObjectType :: Text -> Text -> Text -> PutProfileObjectType
- data PutProfileObjectTypeResponse = PutProfileObjectTypeResponse' (Maybe Natural) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Int Text Text
- newPutProfileObjectTypeResponse :: Int -> Text -> Text -> PutProfileObjectTypeResponse
- data ListProfileObjects = ListProfileObjects' (Maybe ObjectFilter) (Maybe Text) (Maybe Natural) Text Text Text
- newListProfileObjects :: Text -> Text -> Text -> ListProfileObjects
- data ListProfileObjectsResponse = ListProfileObjectsResponse' (Maybe [ListProfileObjectsItem]) (Maybe Text) Int
- newListProfileObjectsResponse :: Int -> ListProfileObjectsResponse
- data ListProfileObjectTypeTemplates = ListProfileObjectTypeTemplates' (Maybe Text) (Maybe Natural)
- newListProfileObjectTypeTemplates :: ListProfileObjectTypeTemplates
- data ListProfileObjectTypeTemplatesResponse = ListProfileObjectTypeTemplatesResponse' (Maybe [ListProfileObjectTypeTemplateItem]) (Maybe Text) Int
- newListProfileObjectTypeTemplatesResponse :: Int -> ListProfileObjectTypeTemplatesResponse
- data DeleteProfile = DeleteProfile' Text Text
- newDeleteProfile :: Text -> Text -> DeleteProfile
- data DeleteProfileResponse = DeleteProfileResponse' (Maybe Text) Int
- newDeleteProfileResponse :: Int -> DeleteProfileResponse
- data UpdateProfile = UpdateProfile' (Maybe UpdateAddress) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe PartyType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateProfile :: Text -> Text -> UpdateProfile
- data UpdateProfileResponse = UpdateProfileResponse' Int Text
- newUpdateProfileResponse :: Int -> Text -> UpdateProfileResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data AddProfileKey = AddProfileKey' Text Text [Text] Text
- newAddProfileKey :: Text -> Text -> Text -> AddProfileKey
- data AddProfileKeyResponse = AddProfileKeyResponse' (Maybe [Text]) (Maybe Text) Int
- newAddProfileKeyResponse :: Int -> AddProfileKeyResponse
- data GetProfileObjectTypeTemplate = GetProfileObjectTypeTemplate' Text
- newGetProfileObjectTypeTemplate :: Text -> GetProfileObjectTypeTemplate
- data GetProfileObjectTypeTemplateResponse = GetProfileObjectTypeTemplateResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) Int
- newGetProfileObjectTypeTemplateResponse :: Int -> GetProfileObjectTypeTemplateResponse
- data GetIntegration = GetIntegration' Text Text
- newGetIntegration :: Text -> Text -> GetIntegration
- data GetIntegrationResponse = GetIntegrationResponse' (Maybe (HashMap Text Text)) Int Text Text Text POSIX POSIX
- newGetIntegrationResponse :: Int -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetIntegrationResponse
- data GetDomain = GetDomain' Text
- newGetDomain :: Text -> GetDomain
- data GetDomainResponse = GetDomainResponse' (Maybe Natural) (Maybe Text) (Maybe MatchingResponse) (Maybe DomainStats) (Maybe Text) (Maybe (HashMap Text Text)) Int Text POSIX POSIX
- newGetDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> GetDomainResponse
- data CreateDomain = CreateDomain' (Maybe Text) (Maybe MatchingRequest) (Maybe Text) (Maybe (HashMap Text Text)) Text Natural
- newCreateDomain :: Text -> Natural -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe Text) (Maybe MatchingResponse) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Natural POSIX POSIX
- newCreateDomainResponse :: Int -> Text -> Natural -> UTCTime -> UTCTime -> CreateDomainResponse
- data DeleteIntegration = DeleteIntegration' Text Text
- newDeleteIntegration :: Text -> Text -> DeleteIntegration
- data DeleteIntegrationResponse = DeleteIntegrationResponse' Int Text
- newDeleteIntegrationResponse :: Int -> Text -> DeleteIntegrationResponse
- data CreateProfile = CreateProfile' (Maybe Address) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe PartyType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newCreateProfile :: Text -> CreateProfile
- data CreateProfileResponse = CreateProfileResponse' Int Text
- newCreateProfileResponse :: Int -> Text -> CreateProfileResponse
- data PutProfileObject = PutProfileObject' Text Text Text
- newPutProfileObject :: Text -> Text -> Text -> PutProfileObject
- data PutProfileObjectResponse = PutProfileObjectResponse' (Maybe Text) Int
- newPutProfileObjectResponse :: Int -> PutProfileObjectResponse
- data PutIntegration = PutIntegration' (Maybe FlowDefinition) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newPutIntegration :: Text -> Text -> PutIntegration
- data PutIntegrationResponse = PutIntegrationResponse' (Maybe (HashMap Text Text)) Int Text Text Text POSIX POSIX
- newPutIntegrationResponse :: Int -> Text -> Text -> Text -> UTCTime -> UTCTime -> PutIntegrationResponse
- data DeleteProfileObject = DeleteProfileObject' Text Text Text Text
- newDeleteProfileObject :: Text -> Text -> Text -> Text -> DeleteProfileObject
- data DeleteProfileObjectResponse = DeleteProfileObjectResponse' (Maybe Text) Int
- newDeleteProfileObjectResponse :: Int -> DeleteProfileObjectResponse
- data ListProfileObjectTypes = ListProfileObjectTypes' (Maybe Text) (Maybe Natural) Text
- newListProfileObjectTypes :: Text -> ListProfileObjectTypes
- data ListProfileObjectTypesResponse = ListProfileObjectTypesResponse' (Maybe [ListProfileObjectTypeItem]) (Maybe Text) Int
- newListProfileObjectTypesResponse :: Int -> ListProfileObjectTypesResponse
- data DeleteProfileKey = DeleteProfileKey' Text Text [Text] Text
- newDeleteProfileKey :: Text -> Text -> Text -> DeleteProfileKey
- data DeleteProfileKeyResponse = DeleteProfileKeyResponse' (Maybe Text) Int
- newDeleteProfileKeyResponse :: Int -> DeleteProfileKeyResponse
- data GetProfileObjectType = GetProfileObjectType' Text Text
- newGetProfileObjectType :: Text -> Text -> GetProfileObjectType
- data GetProfileObjectTypeResponse = GetProfileObjectTypeResponse' (Maybe Natural) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Int Text Text
- newGetProfileObjectTypeResponse :: Int -> Text -> Text -> GetProfileObjectTypeResponse
- data MergeProfiles = MergeProfiles' (Maybe FieldSourceProfileIds) Text Text (NonEmpty Text)
- newMergeProfiles :: Text -> Text -> NonEmpty Text -> MergeProfiles
- data MergeProfilesResponse = MergeProfilesResponse' (Maybe Text) Int
- newMergeProfilesResponse :: Int -> MergeProfilesResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetMatches = GetMatches' (Maybe Text) (Maybe Natural) Text
- newGetMatches :: Text -> GetMatches
- data GetMatchesResponse = GetMatchesResponse' (Maybe [MatchItem]) (Maybe POSIX) (Maybe Text) (Maybe Natural) Int
- newGetMatchesResponse :: Int -> GetMatchesResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data SearchProfiles = SearchProfiles' (Maybe Text) (Maybe Natural) Text Text [Text]
- newSearchProfiles :: Text -> Text -> SearchProfiles
- data SearchProfilesResponse = SearchProfilesResponse' (Maybe [Profile]) (Maybe Text) Int
- newSearchProfilesResponse :: Int -> SearchProfilesResponse
- data ListAccountIntegrations = ListAccountIntegrations' (Maybe Text) (Maybe Natural) Text
- newListAccountIntegrations :: Text -> ListAccountIntegrations
- data ListAccountIntegrationsResponse = ListAccountIntegrationsResponse' (Maybe [ListIntegrationItem]) (Maybe Text) Int
- newListAccountIntegrationsResponse :: Int -> ListAccountIntegrationsResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' Int Text
- newDeleteDomainResponse :: Int -> Text -> DeleteDomainResponse
- data UpdateDomain = UpdateDomain' (Maybe Natural) (Maybe Text) (Maybe MatchingRequest) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newUpdateDomain :: Text -> UpdateDomain
- data UpdateDomainResponse = UpdateDomainResponse' (Maybe Natural) (Maybe Text) (Maybe MatchingResponse) (Maybe Text) (Maybe (HashMap Text Text)) Int Text POSIX POSIX
- newUpdateDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> UpdateDomainResponse
- data ListDomains = ListDomains' (Maybe Text) (Maybe Natural)
- newListDomains :: ListDomains
- data ListDomainsResponse = ListDomainsResponse' (Maybe [ListDomainItem]) (Maybe Text) Int
- newListDomainsResponse :: Int -> ListDomainsResponse
- newtype DataPullMode where
- DataPullMode' { }
- pattern DataPullMode_Complete :: DataPullMode
- pattern DataPullMode_Incremental :: DataPullMode
- newtype FieldContentType where
- FieldContentType' { }
- pattern FieldContentType_EMAIL_ADDRESS :: FieldContentType
- pattern FieldContentType_NAME :: FieldContentType
- pattern FieldContentType_NUMBER :: FieldContentType
- pattern FieldContentType_PHONE_NUMBER :: FieldContentType
- pattern FieldContentType_STRING :: FieldContentType
- newtype Gender where
- Gender' {
- fromGender :: Text
- pattern Gender_FEMALE :: Gender
- pattern Gender_MALE :: Gender
- pattern Gender_UNSPECIFIED :: Gender
- Gender' {
- newtype MarketoConnectorOperator where
- MarketoConnectorOperator' { }
- pattern MarketoConnectorOperator_ADDITION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_BETWEEN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_DIVISION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_GREATER_THAN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_LESS_THAN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_ALL :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_FIRST_N :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_LAST_N :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MULTIPLICATION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_NO_OP :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_PROJECTION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_SUBTRACTION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_NEGATIVE :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_NULL :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_ZERO :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NUMERIC :: MarketoConnectorOperator
- newtype OperatorPropertiesKeys where
- OperatorPropertiesKeys' { }
- pattern OperatorPropertiesKeys_CONCAT_FORMAT :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_DESTINATION_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_LOWER_BOUND :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MASK_LENGTH :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MASK_VALUE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MATH_OPERATION_FIELDS_ORDER :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_SOURCE_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_SUBFIELD_CATEGORY_MAP :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_TRUNCATE_LENGTH :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_UPPER_BOUND :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALIDATION_ACTION :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALUE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALUES :: OperatorPropertiesKeys
- newtype PartyType where
- PartyType' { }
- pattern PartyType_BUSINESS :: PartyType
- pattern PartyType_INDIVIDUAL :: PartyType
- pattern PartyType_OTHER :: PartyType
- newtype S3ConnectorOperator where
- S3ConnectorOperator' { }
- pattern S3ConnectorOperator_ADDITION :: S3ConnectorOperator
- pattern S3ConnectorOperator_BETWEEN :: S3ConnectorOperator
- pattern S3ConnectorOperator_DIVISION :: S3ConnectorOperator
- pattern S3ConnectorOperator_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_GREATER_THAN :: S3ConnectorOperator
- pattern S3ConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_LESS_THAN :: S3ConnectorOperator
- pattern S3ConnectorOperator_LESS_THAN_OR_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_ALL :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_FIRST_N :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_LAST_N :: S3ConnectorOperator
- pattern S3ConnectorOperator_MULTIPLICATION :: S3ConnectorOperator
- pattern S3ConnectorOperator_NOT_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_NO_OP :: S3ConnectorOperator
- pattern S3ConnectorOperator_PROJECTION :: S3ConnectorOperator
- pattern S3ConnectorOperator_SUBTRACTION :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_NEGATIVE :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_NULL :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_ZERO :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NUMERIC :: S3ConnectorOperator
- newtype SalesforceConnectorOperator where
- SalesforceConnectorOperator' { }
- pattern SalesforceConnectorOperator_ADDITION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_BETWEEN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_CONTAINS :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_DIVISION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_GREATER_THAN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_LESS_THAN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_LESS_THAN_OR_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_ALL :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_FIRST_N :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_LAST_N :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MULTIPLICATION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_NOT_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_NO_OP :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_PROJECTION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_SUBTRACTION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_NEGATIVE :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_NULL :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_ZERO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NUMERIC :: SalesforceConnectorOperator
- newtype ServiceNowConnectorOperator where
- ServiceNowConnectorOperator' { }
- pattern ServiceNowConnectorOperator_ADDITION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_BETWEEN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_CONTAINS :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_DIVISION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_GREATER_THAN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_LESS_THAN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_LESS_THAN_OR_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_ALL :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_FIRST_N :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_LAST_N :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MULTIPLICATION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_NOT_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_NO_OP :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_PROJECTION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_SUBTRACTION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_NEGATIVE :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_NULL :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_ZERO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NUMERIC :: ServiceNowConnectorOperator
- newtype SourceConnectorType where
- SourceConnectorType' { }
- pattern SourceConnectorType_Marketo :: SourceConnectorType
- pattern SourceConnectorType_S3 :: SourceConnectorType
- pattern SourceConnectorType_Salesforce :: SourceConnectorType
- pattern SourceConnectorType_Servicenow :: SourceConnectorType
- pattern SourceConnectorType_Zendesk :: SourceConnectorType
- newtype StandardIdentifier where
- StandardIdentifier' { }
- pattern StandardIdentifier_ASSET :: StandardIdentifier
- pattern StandardIdentifier_CASE :: StandardIdentifier
- pattern StandardIdentifier_LOOKUP_ONLY :: StandardIdentifier
- pattern StandardIdentifier_NEW_ONLY :: StandardIdentifier
- pattern StandardIdentifier_PROFILE :: StandardIdentifier
- pattern StandardIdentifier_SECONDARY :: StandardIdentifier
- pattern StandardIdentifier_UNIQUE :: StandardIdentifier
- newtype TaskType where
- TaskType' {
- fromTaskType :: Text
- pattern TaskType_Arithmetic :: TaskType
- pattern TaskType_Filter :: TaskType
- pattern TaskType_Map :: TaskType
- pattern TaskType_Mask :: TaskType
- pattern TaskType_Merge :: TaskType
- pattern TaskType_Truncate :: TaskType
- pattern TaskType_Validate :: TaskType
- TaskType' {
- newtype TriggerType where
- TriggerType' { }
- pattern TriggerType_Event :: TriggerType
- pattern TriggerType_OnDemand :: TriggerType
- pattern TriggerType_Scheduled :: TriggerType
- newtype ZendeskConnectorOperator where
- ZendeskConnectorOperator' { }
- pattern ZendeskConnectorOperator_ADDITION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_DIVISION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_GREATER_THAN :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_ALL :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_FIRST_N :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_LAST_N :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MULTIPLICATION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_NO_OP :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_PROJECTION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_SUBTRACTION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_NEGATIVE :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_NULL :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_ZERO :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NUMERIC :: ZendeskConnectorOperator
- data Address = Address' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAddress :: Address
- data ConnectorOperator = ConnectorOperator' (Maybe ServiceNowConnectorOperator) (Maybe MarketoConnectorOperator) (Maybe SalesforceConnectorOperator) (Maybe ZendeskConnectorOperator) (Maybe S3ConnectorOperator)
- newConnectorOperator :: ConnectorOperator
- data DomainStats = DomainStats' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newDomainStats :: DomainStats
- data FieldSourceProfileIds = FieldSourceProfileIds' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newFieldSourceProfileIds :: FieldSourceProfileIds
- data FlowDefinition = FlowDefinition' (Maybe Text) Text Text SourceFlowConfig [Task] TriggerConfig
- newFlowDefinition :: Text -> Text -> SourceFlowConfig -> TriggerConfig -> FlowDefinition
- data IncrementalPullConfig = IncrementalPullConfig' (Maybe Text)
- newIncrementalPullConfig :: IncrementalPullConfig
- data ListDomainItem = ListDomainItem' (Maybe (HashMap Text Text)) Text POSIX POSIX
- newListDomainItem :: Text -> UTCTime -> UTCTime -> ListDomainItem
- data ListIntegrationItem = ListIntegrationItem' (Maybe (HashMap Text Text)) Text Text Text POSIX POSIX
- newListIntegrationItem :: Text -> Text -> Text -> UTCTime -> UTCTime -> ListIntegrationItem
- data ListProfileObjectTypeItem = ListProfileObjectTypeItem' (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text Text)) Text Text
- newListProfileObjectTypeItem :: Text -> Text -> ListProfileObjectTypeItem
- data ListProfileObjectTypeTemplateItem = ListProfileObjectTypeTemplateItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newListProfileObjectTypeTemplateItem :: ListProfileObjectTypeTemplateItem
- data ListProfileObjectsItem = ListProfileObjectsItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newListProfileObjectsItem :: ListProfileObjectsItem
- data MarketoSourceProperties = MarketoSourceProperties' Text
- newMarketoSourceProperties :: Text -> MarketoSourceProperties
- data MatchItem = MatchItem' (Maybe [Text]) (Maybe Text)
- newMatchItem :: MatchItem
- data MatchingRequest = MatchingRequest' Bool
- newMatchingRequest :: Bool -> MatchingRequest
- data MatchingResponse = MatchingResponse' (Maybe Bool)
- newMatchingResponse :: MatchingResponse
- data ObjectFilter = ObjectFilter' Text [Text]
- newObjectFilter :: Text -> ObjectFilter
- data ObjectTypeField = ObjectTypeField' (Maybe Text) (Maybe FieldContentType) (Maybe Text)
- newObjectTypeField :: ObjectTypeField
- data ObjectTypeKey = ObjectTypeKey' (Maybe [Text]) (Maybe [StandardIdentifier])
- newObjectTypeKey :: ObjectTypeKey
- data Profile = Profile' (Maybe Address) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text)
- newProfile :: Profile
- data S3SourceProperties = S3SourceProperties' (Maybe Text) Text
- newS3SourceProperties :: Text -> S3SourceProperties
- data SalesforceSourceProperties = SalesforceSourceProperties' (Maybe Bool) (Maybe Bool) Text
- newSalesforceSourceProperties :: Text -> SalesforceSourceProperties
- data ScheduledTriggerProperties = ScheduledTriggerProperties' (Maybe POSIX) (Maybe Natural) (Maybe DataPullMode) (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text
- newScheduledTriggerProperties :: Text -> ScheduledTriggerProperties
- data ServiceNowSourceProperties = ServiceNowSourceProperties' Text
- newServiceNowSourceProperties :: Text -> ServiceNowSourceProperties
- data SourceConnectorProperties = SourceConnectorProperties' (Maybe ServiceNowSourceProperties) (Maybe MarketoSourceProperties) (Maybe SalesforceSourceProperties) (Maybe ZendeskSourceProperties) (Maybe S3SourceProperties)
- newSourceConnectorProperties :: SourceConnectorProperties
- data SourceFlowConfig = SourceFlowConfig' (Maybe Text) (Maybe IncrementalPullConfig) SourceConnectorType SourceConnectorProperties
- newSourceFlowConfig :: SourceConnectorType -> SourceConnectorProperties -> SourceFlowConfig
- data Task = Task' (Maybe (HashMap OperatorPropertiesKeys Text)) (Maybe ConnectorOperator) (Maybe Text) [Text] TaskType
- newTask :: TaskType -> Task
- data TriggerConfig = TriggerConfig' (Maybe TriggerProperties) TriggerType
- newTriggerConfig :: TriggerType -> TriggerConfig
- data TriggerProperties = TriggerProperties' (Maybe ScheduledTriggerProperties)
- newTriggerProperties :: TriggerProperties
- data UpdateAddress = UpdateAddress' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUpdateAddress :: UpdateAddress
- data ZendeskSourceProperties = ZendeskSourceProperties' Text
- newZendeskSourceProperties :: Text -> ZendeskSourceProperties
Service Configuration
defaultService :: Service Source #
API version 2020-08-15
of the Amazon Connect Customer Profiles SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CustomerProfiles
.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You exceeded the maximum number of requests.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal service error occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist, or access was denied.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input you provided is invalid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteProfileObjectType
data DeleteProfileObjectType Source #
See: newDeleteProfileObjectType
smart constructor.
Instances
newDeleteProfileObjectType Source #
:: Text | |
-> Text | |
-> DeleteProfileObjectType |
Create a value of DeleteProfileObjectType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DeleteProfileObjectType'
, deleteProfileObjectType_domainName
- The unique name of the domain.
$sel:objectTypeName:DeleteProfileObjectType'
, deleteProfileObjectType_objectTypeName
- The name of the profile object type.
data DeleteProfileObjectTypeResponse Source #
See: newDeleteProfileObjectTypeResponse
smart constructor.
Instances
Eq DeleteProfileObjectTypeResponse Source # | |
Read DeleteProfileObjectTypeResponse Source # | |
Show DeleteProfileObjectTypeResponse Source # | |
Generic DeleteProfileObjectTypeResponse Source # | |
NFData DeleteProfileObjectTypeResponse Source # | |
Defined in Amazonka.CustomerProfiles.DeleteProfileObjectType rnf :: DeleteProfileObjectTypeResponse -> () # | |
type Rep DeleteProfileObjectTypeResponse Source # | |
Defined in Amazonka.CustomerProfiles.DeleteProfileObjectType type Rep DeleteProfileObjectTypeResponse = D1 ('MetaData "DeleteProfileObjectTypeResponse" "Amazonka.CustomerProfiles.DeleteProfileObjectType" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "DeleteProfileObjectTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newDeleteProfileObjectTypeResponse Source #
Create a value of DeleteProfileObjectTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteProfileObjectTypeResponse'
, deleteProfileObjectTypeResponse_httpStatus
- The response's http status code.
$sel:message:DeleteProfileObjectTypeResponse'
, deleteProfileObjectTypeResponse_message
- A message that indicates the delete request is done.
ListIntegrations
data ListIntegrations Source #
See: newListIntegrations
smart constructor.
Instances
Create a value of ListIntegrations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListIntegrations'
, listIntegrations_nextToken
- The pagination token from the previous ListIntegrations API call.
$sel:maxResults:ListIntegrations'
, listIntegrations_maxResults
- The maximum number of objects returned per page.
$sel:domainName:ListIntegrations'
, listIntegrations_domainName
- The unique name of the domain.
data ListIntegrationsResponse Source #
See: newListIntegrationsResponse
smart constructor.
Instances
newListIntegrationsResponse Source #
Create a value of ListIntegrationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListIntegrationsResponse'
, listIntegrationsResponse_items
- The list of ListIntegrations instances.
$sel:nextToken:ListIntegrations'
, listIntegrationsResponse_nextToken
- The pagination token from the previous ListIntegrations API call.
$sel:httpStatus:ListIntegrationsResponse'
, listIntegrationsResponse_httpStatus
- The response's http status code.
PutProfileObjectType
data PutProfileObjectType Source #
See: newPutProfileObjectType
smart constructor.
PutProfileObjectType' (Maybe Natural) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Text Text Text |
Instances
newPutProfileObjectType Source #
:: Text | |
-> Text | |
-> Text | |
-> PutProfileObjectType |
Create a value of PutProfileObjectType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expirationDays:PutProfileObjectType'
, putProfileObjectType_expirationDays
- The number of days until the data in the object expires.
$sel:templateId:PutProfileObjectType'
, putProfileObjectType_templateId
- A unique identifier for the object template.
$sel:keys:PutProfileObjectType'
, putProfileObjectType_keys
- A list of unique keys that can be used to map data to the profile.
$sel:encryptionKey:PutProfileObjectType'
, putProfileObjectType_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
$sel:allowProfileCreation:PutProfileObjectType'
, putProfileObjectType_allowProfileCreation
- 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.
$sel:fields:PutProfileObjectType'
, putProfileObjectType_fields
- A map of the name and ObjectType field.
$sel:tags:PutProfileObjectType'
, putProfileObjectType_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:PutProfileObjectType'
, putProfileObjectType_domainName
- The unique name of the domain.
$sel:objectTypeName:PutProfileObjectType'
, putProfileObjectType_objectTypeName
- The name of the profile object type.
$sel:description:PutProfileObjectType'
, putProfileObjectType_description
- Description of the profile object type.
data PutProfileObjectTypeResponse Source #
See: newPutProfileObjectTypeResponse
smart constructor.
PutProfileObjectTypeResponse' (Maybe Natural) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Int Text Text |
Instances
newPutProfileObjectTypeResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> PutProfileObjectTypeResponse |
Create a value of PutProfileObjectTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expirationDays:PutProfileObjectType'
, putProfileObjectTypeResponse_expirationDays
- The number of days until the data in the object expires.
$sel:lastUpdatedAt:PutProfileObjectTypeResponse'
, putProfileObjectTypeResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
$sel:createdAt:PutProfileObjectTypeResponse'
, putProfileObjectTypeResponse_createdAt
- The timestamp of when the domain was created.
$sel:templateId:PutProfileObjectType'
, putProfileObjectTypeResponse_templateId
- A unique identifier for the object template.
$sel:keys:PutProfileObjectType'
, putProfileObjectTypeResponse_keys
- A list of unique keys that can be used to map data to the profile.
$sel:encryptionKey:PutProfileObjectType'
, putProfileObjectTypeResponse_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
$sel:allowProfileCreation:PutProfileObjectType'
, putProfileObjectTypeResponse_allowProfileCreation
- 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.
$sel:fields:PutProfileObjectType'
, putProfileObjectTypeResponse_fields
- A map of the name and ObjectType field.
$sel:tags:PutProfileObjectType'
, putProfileObjectTypeResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:PutProfileObjectTypeResponse'
, putProfileObjectTypeResponse_httpStatus
- The response's http status code.
$sel:objectTypeName:PutProfileObjectType'
, putProfileObjectTypeResponse_objectTypeName
- The name of the profile object type.
$sel:description:PutProfileObjectType'
, putProfileObjectTypeResponse_description
- Description of the profile object type.
ListProfileObjects
data ListProfileObjects Source #
See: newListProfileObjects
smart constructor.
Instances
newListProfileObjects Source #
:: Text | |
-> Text | |
-> Text | |
-> ListProfileObjects |
Create a value of ListProfileObjects
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectFilter:ListProfileObjects'
, listProfileObjects_objectFilter
- 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.
$sel:nextToken:ListProfileObjects'
, listProfileObjects_nextToken
- The pagination token from the previous call to ListProfileObjects.
$sel:maxResults:ListProfileObjects'
, listProfileObjects_maxResults
- The maximum number of objects returned per page.
$sel:domainName:ListProfileObjects'
, listProfileObjects_domainName
- The unique name of the domain.
$sel:objectTypeName:ListProfileObjects'
, listProfileObjects_objectTypeName
- The name of the profile object type.
$sel:profileId:ListProfileObjects'
, listProfileObjects_profileId
- The unique identifier of a customer profile.
data ListProfileObjectsResponse Source #
See: newListProfileObjectsResponse
smart constructor.
Instances
newListProfileObjectsResponse Source #
Create a value of ListProfileObjectsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListProfileObjectsResponse'
, listProfileObjectsResponse_items
- The list of ListProfileObject instances.
$sel:nextToken:ListProfileObjects'
, listProfileObjectsResponse_nextToken
- The pagination token from the previous call to ListProfileObjects.
$sel:httpStatus:ListProfileObjectsResponse'
, listProfileObjectsResponse_httpStatus
- The response's http status code.
ListProfileObjectTypeTemplates
data ListProfileObjectTypeTemplates Source #
See: newListProfileObjectTypeTemplates
smart constructor.
Instances
newListProfileObjectTypeTemplates :: ListProfileObjectTypeTemplates Source #
Create a value of ListProfileObjectTypeTemplates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListProfileObjectTypeTemplates'
, listProfileObjectTypeTemplates_nextToken
- The pagination token from the previous ListObjectTypeTemplates API call.
$sel:maxResults:ListProfileObjectTypeTemplates'
, listProfileObjectTypeTemplates_maxResults
- The maximum number of objects returned per page.
data ListProfileObjectTypeTemplatesResponse Source #
See: newListProfileObjectTypeTemplatesResponse
smart constructor.
ListProfileObjectTypeTemplatesResponse' (Maybe [ListProfileObjectTypeTemplateItem]) (Maybe Text) Int |
Instances
newListProfileObjectTypeTemplatesResponse Source #
Create a value of ListProfileObjectTypeTemplatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListProfileObjectTypeTemplatesResponse'
, listProfileObjectTypeTemplatesResponse_items
- The list of ListProfileObjectType template instances.
$sel:nextToken:ListProfileObjectTypeTemplates'
, listProfileObjectTypeTemplatesResponse_nextToken
- The pagination token from the previous ListObjectTypeTemplates API call.
$sel:httpStatus:ListProfileObjectTypeTemplatesResponse'
, listProfileObjectTypeTemplatesResponse_httpStatus
- The response's http status code.
DeleteProfile
data DeleteProfile Source #
See: newDeleteProfile
smart constructor.
Instances
Create a value of DeleteProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileId:DeleteProfile'
, deleteProfile_profileId
- The unique identifier of a customer profile.
$sel:domainName:DeleteProfile'
, deleteProfile_domainName
- The unique name of the domain.
data DeleteProfileResponse Source #
See: newDeleteProfileResponse
smart constructor.
Instances
newDeleteProfileResponse Source #
Create a value of DeleteProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DeleteProfileResponse'
, deleteProfileResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileResponse'
, deleteProfileResponse_httpStatus
- The response's http status code.
UpdateProfile
data UpdateProfile Source #
See: newUpdateProfile
smart constructor.
UpdateProfile' (Maybe UpdateAddress) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe PartyType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Create a value of UpdateProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:UpdateProfile'
, updateProfile_shippingAddress
- The customer’s shipping address.
$sel:mobilePhoneNumber:UpdateProfile'
, updateProfile_mobilePhoneNumber
- The customer’s mobile phone number.
$sel:mailingAddress:UpdateProfile'
, updateProfile_mailingAddress
- The customer’s mailing address.
$sel:middleName:UpdateProfile'
, updateProfile_middleName
- The customer’s middle name.
$sel:personalEmailAddress:UpdateProfile'
, updateProfile_personalEmailAddress
- The customer’s personal email address.
$sel:lastName:UpdateProfile'
, updateProfile_lastName
- The customer’s last name.
$sel:additionalInformation:UpdateProfile'
, updateProfile_additionalInformation
- Any additional information relevant to the customer’s profile.
$sel:homePhoneNumber:UpdateProfile'
, updateProfile_homePhoneNumber
- The customer’s home phone number.
$sel:address:UpdateProfile'
, updateProfile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
$sel:partyType:UpdateProfile'
, updateProfile_partyType
- The type of profile used to describe the customer.
$sel:businessEmailAddress:UpdateProfile'
, updateProfile_businessEmailAddress
- The customer’s business email address.
$sel:attributes:UpdateProfile'
, updateProfile_attributes
- A key value pair of attributes of a customer profile.
$sel:gender:UpdateProfile'
, updateProfile_gender
- The gender with which the customer identifies.
$sel:phoneNumber:UpdateProfile'
, updateProfile_phoneNumber
- The customer’s phone number, which has not been specified as a mobile,
home, or business number.
$sel:accountNumber:UpdateProfile'
, updateProfile_accountNumber
- A unique account number that you have given to the customer.
$sel:emailAddress:UpdateProfile'
, updateProfile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
$sel:firstName:UpdateProfile'
, updateProfile_firstName
- The customer’s first name.
$sel:billingAddress:UpdateProfile'
, updateProfile_billingAddress
- The customer’s billing address.
$sel:businessPhoneNumber:UpdateProfile'
, updateProfile_businessPhoneNumber
- The customer’s business phone number.
$sel:birthDate:UpdateProfile'
, updateProfile_birthDate
- The customer’s birth date.
$sel:businessName:UpdateProfile'
, updateProfile_businessName
- The name of the customer’s business.
$sel:domainName:UpdateProfile'
, updateProfile_domainName
- The unique name of the domain.
$sel:profileId:UpdateProfile'
, updateProfile_profileId
- The unique identifier of a customer profile.
data UpdateProfileResponse Source #
See: newUpdateProfileResponse
smart constructor.
Instances
newUpdateProfileResponse Source #
:: Int | |
-> Text | |
-> UpdateProfileResponse |
Create a value of UpdateProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProfileResponse'
, updateProfileResponse_httpStatus
- The response's http status code.
$sel:profileId:UpdateProfile'
, updateProfileResponse_profileId
- The unique identifier of a customer profile.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource for which you want to view tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
AddProfileKey
data AddProfileKey Source #
See: newAddProfileKey
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> AddProfileKey |
Create a value of AddProfileKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileId:AddProfileKey'
, addProfileKey_profileId
- The unique identifier of a customer profile.
$sel:keyName:AddProfileKey'
, addProfileKey_keyName
- A searchable identifier of a customer profile.
$sel:values:AddProfileKey'
, addProfileKey_values
- A list of key values.
$sel:domainName:AddProfileKey'
, addProfileKey_domainName
- The unique name of the domain.
data AddProfileKeyResponse Source #
See: newAddProfileKeyResponse
smart constructor.
Instances
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:
$sel:values:AddProfileKey'
, addProfileKeyResponse_values
- A list of key values.
$sel:keyName:AddProfileKey'
, addProfileKeyResponse_keyName
- A searchable identifier of a customer profile.
$sel:httpStatus:AddProfileKeyResponse'
, addProfileKeyResponse_httpStatus
- The response's http status code.
GetProfileObjectTypeTemplate
data GetProfileObjectTypeTemplate Source #
See: newGetProfileObjectTypeTemplate
smart constructor.
Instances
newGetProfileObjectTypeTemplate Source #
Create a value of GetProfileObjectTypeTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:templateId:GetProfileObjectTypeTemplate'
, getProfileObjectTypeTemplate_templateId
- A unique identifier for the object template.
data GetProfileObjectTypeTemplateResponse Source #
See: newGetProfileObjectTypeTemplateResponse
smart constructor.
GetProfileObjectTypeTemplateResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) Int |
Instances
newGetProfileObjectTypeTemplateResponse Source #
Create a value of GetProfileObjectTypeTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceName:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_sourceName
- The name of the source of the object template.
$sel:templateId:GetProfileObjectTypeTemplate'
, getProfileObjectTypeTemplateResponse_templateId
- A unique identifier for the object template.
$sel:sourceObject:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_sourceObject
- The source of the object template.
$sel:keys:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_keys
- A list of unique keys that can be used to map data to the profile.
$sel:allowProfileCreation:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_allowProfileCreation
- 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.
$sel:fields:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_fields
- A map of the name and ObjectType field.
$sel:httpStatus:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_httpStatus
- The response's http status code.
GetIntegration
data GetIntegration Source #
See: newGetIntegration
smart constructor.
Instances
Create a value of GetIntegration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:GetIntegration'
, getIntegration_domainName
- The unique name of the domain.
$sel:uri:GetIntegration'
, getIntegration_uri
- The URI of the S3 bucket or any other type of data source.
data GetIntegrationResponse Source #
See: newGetIntegrationResponse
smart constructor.
Instances
newGetIntegrationResponse Source #
Create a value of GetIntegrationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:GetIntegrationResponse'
, getIntegrationResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:GetIntegrationResponse'
, getIntegrationResponse_httpStatus
- The response's http status code.
$sel:domainName:GetIntegration'
, getIntegrationResponse_domainName
- The unique name of the domain.
$sel:uri:GetIntegration'
, getIntegrationResponse_uri
- The URI of the S3 bucket or any other type of data source.
$sel:objectTypeName:GetIntegrationResponse'
, getIntegrationResponse_objectTypeName
- The name of the profile object type.
$sel:createdAt:GetIntegrationResponse'
, getIntegrationResponse_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:GetIntegrationResponse'
, getIntegrationResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
GetDomain
See: newGetDomain
smart constructor.
Instances
Create a value of GetDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:GetDomain'
, getDomain_domainName
- The unique name of the domain.
data GetDomainResponse Source #
See: newGetDomainResponse
smart constructor.
GetDomainResponse' (Maybe Natural) (Maybe Text) (Maybe MatchingResponse) (Maybe DomainStats) (Maybe Text) (Maybe (HashMap Text Text)) Int Text POSIX POSIX |
Instances
:: Int | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> GetDomainResponse |
Create a value of GetDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultExpirationDays:GetDomainResponse'
, getDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:defaultEncryptionKey:GetDomainResponse'
, getDomainResponse_defaultEncryptionKey
- 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.
$sel:matching:GetDomainResponse'
, getDomainResponse_matching
- 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.
$sel:stats:GetDomainResponse'
, getDomainResponse_stats
- Usage-specific statistics about the domain.
$sel:deadLetterQueueUrl:GetDomainResponse'
, getDomainResponse_deadLetterQueueUrl
- The URL of the SQS dead letter queue, which is used for reporting errors
associated with ingesting data from third party applications.
$sel:tags:GetDomainResponse'
, getDomainResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:GetDomainResponse'
, getDomainResponse_httpStatus
- The response's http status code.
$sel:domainName:GetDomain'
, getDomainResponse_domainName
- The unique name of the domain.
$sel:createdAt:GetDomainResponse'
, getDomainResponse_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:GetDomainResponse'
, getDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
CreateDomain
data CreateDomain Source #
See: newCreateDomain
smart constructor.
CreateDomain' (Maybe Text) (Maybe MatchingRequest) (Maybe Text) (Maybe (HashMap Text Text)) Text Natural |
Instances
:: Text | |
-> Natural | |
-> CreateDomain |
Create a value of CreateDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultEncryptionKey:CreateDomain'
, createDomain_defaultEncryptionKey
- 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.
$sel:matching:CreateDomain'
, createDomain_matching
- 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.
$sel:deadLetterQueueUrl:CreateDomain'
, createDomain_deadLetterQueueUrl
- 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.
$sel:tags:CreateDomain'
, createDomain_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:CreateDomain'
, createDomain_domainName
- The unique name of the domain.
$sel:defaultExpirationDays:CreateDomain'
, createDomain_defaultExpirationDays
- The default number of days until the data within the domain expires.
data CreateDomainResponse Source #
See: newCreateDomainResponse
smart constructor.
CreateDomainResponse' (Maybe Text) (Maybe MatchingResponse) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Natural POSIX POSIX |
Instances
newCreateDomainResponse Source #
Create a value of CreateDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultEncryptionKey:CreateDomain'
, createDomainResponse_defaultEncryptionKey
- 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.
$sel:matching:CreateDomain'
, createDomainResponse_matching
- 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.
$sel:deadLetterQueueUrl:CreateDomain'
, createDomainResponse_deadLetterQueueUrl
- The URL of the SQS dead letter queue, which is used for reporting errors
associated with ingesting data from third party applications.
$sel:tags:CreateDomain'
, createDomainResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:CreateDomainResponse'
, createDomainResponse_httpStatus
- The response's http status code.
$sel:domainName:CreateDomain'
, createDomainResponse_domainName
- The unique name of the domain.
$sel:defaultExpirationDays:CreateDomain'
, createDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:createdAt:CreateDomainResponse'
, createDomainResponse_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:CreateDomainResponse'
, createDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
DeleteIntegration
data DeleteIntegration Source #
See: newDeleteIntegration
smart constructor.
Instances
Create a value of DeleteIntegration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DeleteIntegration'
, deleteIntegration_domainName
- The unique name of the domain.
$sel:uri:DeleteIntegration'
, deleteIntegration_uri
- The URI of the S3 bucket or any other type of data source.
data DeleteIntegrationResponse Source #
See: newDeleteIntegrationResponse
smart constructor.
Instances
newDeleteIntegrationResponse Source #
:: Int | |
-> Text | |
-> DeleteIntegrationResponse |
Create a value of DeleteIntegrationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteIntegrationResponse'
, deleteIntegrationResponse_httpStatus
- The response's http status code.
$sel:message:DeleteIntegrationResponse'
, deleteIntegrationResponse_message
- A message that indicates the delete request is done.
CreateProfile
data CreateProfile Source #
See: newCreateProfile
smart constructor.
CreateProfile' (Maybe Address) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe PartyType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of CreateProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:CreateProfile'
, createProfile_shippingAddress
- The customer’s shipping address.
$sel:mobilePhoneNumber:CreateProfile'
, createProfile_mobilePhoneNumber
- The customer’s mobile phone number.
$sel:mailingAddress:CreateProfile'
, createProfile_mailingAddress
- The customer’s mailing address.
$sel:middleName:CreateProfile'
, createProfile_middleName
- The customer’s middle name.
$sel:personalEmailAddress:CreateProfile'
, createProfile_personalEmailAddress
- The customer’s personal email address.
$sel:lastName:CreateProfile'
, createProfile_lastName
- The customer’s last name.
$sel:additionalInformation:CreateProfile'
, createProfile_additionalInformation
- Any additional information relevant to the customer’s profile.
$sel:homePhoneNumber:CreateProfile'
, createProfile_homePhoneNumber
- The customer’s home phone number.
$sel:address:CreateProfile'
, createProfile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
$sel:partyType:CreateProfile'
, createProfile_partyType
- The type of profile used to describe the customer.
$sel:businessEmailAddress:CreateProfile'
, createProfile_businessEmailAddress
- The customer’s business email address.
$sel:attributes:CreateProfile'
, createProfile_attributes
- A key value pair of attributes of a customer profile.
$sel:gender:CreateProfile'
, createProfile_gender
- The gender with which the customer identifies.
$sel:phoneNumber:CreateProfile'
, createProfile_phoneNumber
- The customer’s phone number, which has not been specified as a mobile,
home, or business number.
$sel:accountNumber:CreateProfile'
, createProfile_accountNumber
- A unique account number that you have given to the customer.
$sel:emailAddress:CreateProfile'
, createProfile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
$sel:firstName:CreateProfile'
, createProfile_firstName
- The customer’s first name.
$sel:billingAddress:CreateProfile'
, createProfile_billingAddress
- The customer’s billing address.
$sel:businessPhoneNumber:CreateProfile'
, createProfile_businessPhoneNumber
- The customer’s business phone number.
$sel:birthDate:CreateProfile'
, createProfile_birthDate
- The customer’s birth date.
$sel:businessName:CreateProfile'
, createProfile_businessName
- The name of the customer’s business.
$sel:domainName:CreateProfile'
, createProfile_domainName
- The unique name of the domain.
data CreateProfileResponse Source #
See: newCreateProfileResponse
smart constructor.
Instances
newCreateProfileResponse Source #
:: Int | |
-> Text | |
-> CreateProfileResponse |
Create a value of CreateProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateProfileResponse'
, createProfileResponse_httpStatus
- The response's http status code.
$sel:profileId:CreateProfileResponse'
, createProfileResponse_profileId
- The unique identifier of a customer profile.
PutProfileObject
data PutProfileObject Source #
See: newPutProfileObject
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> PutProfileObject |
Create a value of PutProfileObject
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectTypeName:PutProfileObject'
, putProfileObject_objectTypeName
- The name of the profile object type.
$sel:object':PutProfileObject'
, putProfileObject_object
- A string that is serialized from a JSON object.
$sel:domainName:PutProfileObject'
, putProfileObject_domainName
- The unique name of the domain.
data PutProfileObjectResponse Source #
See: newPutProfileObjectResponse
smart constructor.
Instances
newPutProfileObjectResponse Source #
Create a value of PutProfileObjectResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileObjectUniqueKey:PutProfileObjectResponse'
, putProfileObjectResponse_profileObjectUniqueKey
- The unique identifier of the profile object generated by the service.
$sel:httpStatus:PutProfileObjectResponse'
, putProfileObjectResponse_httpStatus
- The response's http status code.
PutIntegration
data PutIntegration Source #
See: newPutIntegration
smart constructor.
Instances
Create a value of PutIntegration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:flowDefinition:PutIntegration'
, putIntegration_flowDefinition
- The configuration that controls how Customer Profiles retrieves data
from the source.
$sel:uri:PutIntegration'
, putIntegration_uri
- The URI of the S3 bucket or any other type of data source.
$sel:tags:PutIntegration'
, putIntegration_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:PutIntegration'
, putIntegration_domainName
- The unique name of the domain.
$sel:objectTypeName:PutIntegration'
, putIntegration_objectTypeName
- The name of the profile object type.
data PutIntegrationResponse Source #
See: newPutIntegrationResponse
smart constructor.
Instances
newPutIntegrationResponse Source #
Create a value of PutIntegrationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:PutIntegration'
, putIntegrationResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:PutIntegrationResponse'
, putIntegrationResponse_httpStatus
- The response's http status code.
$sel:domainName:PutIntegration'
, putIntegrationResponse_domainName
- The unique name of the domain.
$sel:uri:PutIntegration'
, putIntegrationResponse_uri
- The URI of the S3 bucket or any other type of data source.
$sel:objectTypeName:PutIntegration'
, putIntegrationResponse_objectTypeName
- The name of the profile object type.
$sel:createdAt:PutIntegrationResponse'
, putIntegrationResponse_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:PutIntegrationResponse'
, putIntegrationResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
DeleteProfileObject
data DeleteProfileObject Source #
See: newDeleteProfileObject
smart constructor.
Instances
newDeleteProfileObject Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> DeleteProfileObject |
Create a value of DeleteProfileObject
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileId:DeleteProfileObject'
, deleteProfileObject_profileId
- The unique identifier of a customer profile.
$sel:profileObjectUniqueKey:DeleteProfileObject'
, deleteProfileObject_profileObjectUniqueKey
- The unique identifier of the profile object generated by the service.
$sel:objectTypeName:DeleteProfileObject'
, deleteProfileObject_objectTypeName
- The name of the profile object type.
$sel:domainName:DeleteProfileObject'
, deleteProfileObject_domainName
- The unique name of the domain.
data DeleteProfileObjectResponse Source #
See: newDeleteProfileObjectResponse
smart constructor.
Instances
newDeleteProfileObjectResponse Source #
Create a value of DeleteProfileObjectResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DeleteProfileObjectResponse'
, deleteProfileObjectResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileObjectResponse'
, deleteProfileObjectResponse_httpStatus
- The response's http status code.
ListProfileObjectTypes
data ListProfileObjectTypes Source #
See: newListProfileObjectTypes
smart constructor.
Instances
newListProfileObjectTypes Source #
Create a value of ListProfileObjectTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListProfileObjectTypes'
, listProfileObjectTypes_nextToken
- Identifies the next page of results to return.
$sel:maxResults:ListProfileObjectTypes'
, listProfileObjectTypes_maxResults
- The maximum number of objects returned per page.
$sel:domainName:ListProfileObjectTypes'
, listProfileObjectTypes_domainName
- The unique name of the domain.
data ListProfileObjectTypesResponse Source #
See: newListProfileObjectTypesResponse
smart constructor.
Instances
newListProfileObjectTypesResponse Source #
Create a value of ListProfileObjectTypesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListProfileObjectTypesResponse'
, listProfileObjectTypesResponse_items
- The list of ListProfileObjectTypes instances.
$sel:nextToken:ListProfileObjectTypes'
, listProfileObjectTypesResponse_nextToken
- Identifies the next page of results to return.
$sel:httpStatus:ListProfileObjectTypesResponse'
, listProfileObjectTypesResponse_httpStatus
- The response's http status code.
DeleteProfileKey
data DeleteProfileKey Source #
See: newDeleteProfileKey
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteProfileKey |
Create a value of DeleteProfileKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileId:DeleteProfileKey'
, deleteProfileKey_profileId
- The unique identifier of a customer profile.
$sel:keyName:DeleteProfileKey'
, deleteProfileKey_keyName
- A searchable identifier of a customer profile.
$sel:values:DeleteProfileKey'
, deleteProfileKey_values
- A list of key values.
$sel:domainName:DeleteProfileKey'
, deleteProfileKey_domainName
- The unique name of the domain.
data DeleteProfileKeyResponse Source #
See: newDeleteProfileKeyResponse
smart constructor.
Instances
newDeleteProfileKeyResponse Source #
Create a value of DeleteProfileKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DeleteProfileKeyResponse'
, deleteProfileKeyResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileKeyResponse'
, deleteProfileKeyResponse_httpStatus
- The response's http status code.
GetProfileObjectType
data GetProfileObjectType Source #
See: newGetProfileObjectType
smart constructor.
Instances
newGetProfileObjectType Source #
:: Text | |
-> Text | |
-> GetProfileObjectType |
Create a value of GetProfileObjectType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:GetProfileObjectType'
, getProfileObjectType_domainName
- The unique name of the domain.
$sel:objectTypeName:GetProfileObjectType'
, getProfileObjectType_objectTypeName
- The name of the profile object type.
data GetProfileObjectTypeResponse Source #
See: newGetProfileObjectTypeResponse
smart constructor.
GetProfileObjectTypeResponse' (Maybe Natural) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text Text)) Int Text Text |
Instances
newGetProfileObjectTypeResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> GetProfileObjectTypeResponse |
Create a value of GetProfileObjectTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expirationDays:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_expirationDays
- The number of days until the data in the object expires.
$sel:lastUpdatedAt:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
$sel:createdAt:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_createdAt
- The timestamp of when the domain was created.
$sel:templateId:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_templateId
- A unique identifier for the object template.
$sel:keys:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_keys
- A list of unique keys that can be used to map data to the profile.
$sel:encryptionKey:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
$sel:allowProfileCreation:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_allowProfileCreation
- 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.
$sel:fields:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_fields
- A map of the name and ObjectType field.
$sel:tags:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_httpStatus
- The response's http status code.
$sel:objectTypeName:GetProfileObjectType'
, getProfileObjectTypeResponse_objectTypeName
- The name of the profile object type.
$sel:description:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_description
- The description of the profile object type.
MergeProfiles
data MergeProfiles Source #
See: newMergeProfiles
smart constructor.
Instances
:: Text | |
-> Text | |
-> NonEmpty Text | |
-> MergeProfiles |
Create a value of MergeProfiles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldSourceProfileIds:MergeProfiles'
, mergeProfiles_fieldSourceProfileIds
- The identifiers of the fields in the profile that has the information
you want to apply to the merge. For example, say you want to merge
EmailAddress from Profile1 into MainProfile. This would be the
identifier of the EmailAddress field in Profile1.
$sel:domainName:MergeProfiles'
, mergeProfiles_domainName
- The unique name of the domain.
$sel:mainProfileId:MergeProfiles'
, mergeProfiles_mainProfileId
- The identifier of the profile to be taken.
$sel:profileIdsToBeMerged:MergeProfiles'
, mergeProfiles_profileIdsToBeMerged
- The identifier of the profile to be merged into MainProfileId.
data MergeProfilesResponse Source #
See: newMergeProfilesResponse
smart constructor.
Instances
newMergeProfilesResponse Source #
Create a value of MergeProfilesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:MergeProfilesResponse'
, mergeProfilesResponse_message
- A message that indicates the merge request is complete.
$sel:httpStatus:MergeProfilesResponse'
, mergeProfilesResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the resource that you're adding tags to.
$sel:tags:TagResource'
, tagResource_tags
- The tags used to organize, track, or control access for this resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
GetMatches
data GetMatches Source #
See: newGetMatches
smart constructor.
Instances
Create a value of GetMatches
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetMatches'
, getMatches_nextToken
- 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.
$sel:maxResults:GetMatches'
, getMatches_maxResults
- The maximum number of results to return per page.
$sel:domainName:GetMatches'
, getMatches_domainName
- The unique name of the domain.
data GetMatchesResponse Source #
See: newGetMatchesResponse
smart constructor.
Instances
newGetMatchesResponse Source #
Create a value of GetMatchesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matches:GetMatchesResponse'
, getMatchesResponse_matches
- The list of matched profiles for this instance.
$sel:matchGenerationDate:GetMatchesResponse'
, getMatchesResponse_matchGenerationDate
- The timestamp this version of Match Result generated.
$sel:nextToken:GetMatches'
, getMatchesResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:potentialMatches:GetMatchesResponse'
, getMatchesResponse_potentialMatches
- The number of potential matches found.
$sel:httpStatus:GetMatchesResponse'
, getMatchesResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The ARN of the resource from which you are removing tags.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
SearchProfiles
data SearchProfiles Source #
See: newSearchProfiles
smart constructor.
Instances
Create a value of SearchProfiles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SearchProfiles'
, searchProfiles_nextToken
- The pagination token from the previous SearchProfiles API call.
$sel:maxResults:SearchProfiles'
, searchProfiles_maxResults
- The maximum number of objects returned per page.
$sel:domainName:SearchProfiles'
, searchProfiles_domainName
- The unique name of the domain.
$sel:keyName:SearchProfiles'
, searchProfiles_keyName
- 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.
$sel:values:SearchProfiles'
, searchProfiles_values
- A list of key values.
data SearchProfilesResponse Source #
See: newSearchProfilesResponse
smart constructor.
Instances
newSearchProfilesResponse Source #
Create a value of SearchProfilesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:SearchProfilesResponse'
, searchProfilesResponse_items
- The list of SearchProfiles instances.
$sel:nextToken:SearchProfiles'
, searchProfilesResponse_nextToken
- The pagination token from the previous SearchProfiles API call.
$sel:httpStatus:SearchProfilesResponse'
, searchProfilesResponse_httpStatus
- The response's http status code.
ListAccountIntegrations
data ListAccountIntegrations Source #
See: newListAccountIntegrations
smart constructor.
Instances
newListAccountIntegrations Source #
Create a value of ListAccountIntegrations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAccountIntegrations'
, listAccountIntegrations_nextToken
- The pagination token from the previous ListAccountIntegrations API call.
$sel:maxResults:ListAccountIntegrations'
, listAccountIntegrations_maxResults
- The maximum number of objects returned per page.
$sel:uri:ListAccountIntegrations'
, listAccountIntegrations_uri
- The URI of the S3 bucket or any other type of data source.
data ListAccountIntegrationsResponse Source #
See: newListAccountIntegrationsResponse
smart constructor.
Instances
newListAccountIntegrationsResponse Source #
Create a value of ListAccountIntegrationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListAccountIntegrationsResponse'
, listAccountIntegrationsResponse_items
- The list of ListAccountIntegration instances.
$sel:nextToken:ListAccountIntegrations'
, listAccountIntegrationsResponse_nextToken
- The pagination token from the previous ListAccountIntegrations API call.
$sel:httpStatus:ListAccountIntegrationsResponse'
, listAccountIntegrationsResponse_httpStatus
- The response's http status code.
DeleteDomain
data DeleteDomain Source #
See: newDeleteDomain
smart constructor.
Instances
Create a value of DeleteDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DeleteDomain'
, deleteDomain_domainName
- The unique name of the domain.
data DeleteDomainResponse Source #
See: newDeleteDomainResponse
smart constructor.
Instances
newDeleteDomainResponse Source #
:: Int | |
-> Text | |
-> DeleteDomainResponse |
Create a value of DeleteDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDomainResponse'
, deleteDomainResponse_httpStatus
- The response's http status code.
$sel:message:DeleteDomainResponse'
, deleteDomainResponse_message
- A message that indicates the delete request is done.
UpdateDomain
data UpdateDomain Source #
See: newUpdateDomain
smart constructor.
UpdateDomain' (Maybe Natural) (Maybe Text) (Maybe MatchingRequest) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
Create a value of UpdateDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultExpirationDays:UpdateDomain'
, updateDomain_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:defaultEncryptionKey:UpdateDomain'
, updateDomain_defaultEncryptionKey
- 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.
$sel:matching:UpdateDomain'
, updateDomain_matching
- 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.
$sel:deadLetterQueueUrl:UpdateDomain'
, updateDomain_deadLetterQueueUrl
- 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.
$sel:tags:UpdateDomain'
, updateDomain_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:UpdateDomain'
, updateDomain_domainName
- The unique name of the domain.
data UpdateDomainResponse Source #
See: newUpdateDomainResponse
smart constructor.
UpdateDomainResponse' (Maybe Natural) (Maybe Text) (Maybe MatchingResponse) (Maybe Text) (Maybe (HashMap Text Text)) Int Text POSIX POSIX |
Instances
newUpdateDomainResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> UpdateDomainResponse |
Create a value of UpdateDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultExpirationDays:UpdateDomain'
, updateDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:defaultEncryptionKey:UpdateDomain'
, updateDomainResponse_defaultEncryptionKey
- 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.
$sel:matching:UpdateDomain'
, updateDomainResponse_matching
- 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.
$sel:deadLetterQueueUrl:UpdateDomain'
, updateDomainResponse_deadLetterQueueUrl
- The URL of the SQS dead letter queue, which is used for reporting errors
associated with ingesting data from third party applications.
$sel:tags:UpdateDomain'
, updateDomainResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:UpdateDomainResponse'
, updateDomainResponse_httpStatus
- The response's http status code.
$sel:domainName:UpdateDomain'
, updateDomainResponse_domainName
- The unique name of the domain.
$sel:createdAt:UpdateDomainResponse'
, updateDomainResponse_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:UpdateDomainResponse'
, updateDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
ListDomains
data ListDomains Source #
See: newListDomains
smart constructor.
Instances
newListDomains :: ListDomains Source #
Create a value of ListDomains
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDomains'
, listDomains_nextToken
- The pagination token from the previous ListDomain API call.
$sel:maxResults:ListDomains'
, listDomains_maxResults
- The maximum number of objects returned per page.
data ListDomainsResponse Source #
See: newListDomainsResponse
smart constructor.
Instances
newListDomainsResponse Source #
Create a value of ListDomainsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListDomainsResponse'
, listDomainsResponse_items
- The list of ListDomains instances.
$sel:nextToken:ListDomains'
, listDomainsResponse_nextToken
- The pagination token from the previous ListDomains API call.
$sel:httpStatus:ListDomainsResponse'
, listDomainsResponse_httpStatus
- The response's http status code.
Types
DataPullMode
newtype DataPullMode Source #
pattern DataPullMode_Complete :: DataPullMode | |
pattern DataPullMode_Incremental :: DataPullMode |
Instances
FieldContentType
newtype FieldContentType Source #
pattern FieldContentType_EMAIL_ADDRESS :: FieldContentType | |
pattern FieldContentType_NAME :: FieldContentType | |
pattern FieldContentType_NUMBER :: FieldContentType | |
pattern FieldContentType_PHONE_NUMBER :: FieldContentType | |
pattern FieldContentType_STRING :: FieldContentType |
Instances
Gender
pattern Gender_FEMALE :: Gender | |
pattern Gender_MALE :: Gender | |
pattern Gender_UNSPECIFIED :: Gender |
Instances
MarketoConnectorOperator
newtype MarketoConnectorOperator Source #
Instances
OperatorPropertiesKeys
newtype OperatorPropertiesKeys Source #
Instances
PartyType
pattern PartyType_BUSINESS :: PartyType | |
pattern PartyType_INDIVIDUAL :: PartyType | |
pattern PartyType_OTHER :: PartyType |
Instances
S3ConnectorOperator
newtype S3ConnectorOperator Source #
Instances
SalesforceConnectorOperator
newtype SalesforceConnectorOperator Source #
Instances
ServiceNowConnectorOperator
newtype ServiceNowConnectorOperator Source #
Instances
SourceConnectorType
newtype SourceConnectorType Source #
pattern SourceConnectorType_Marketo :: SourceConnectorType | |
pattern SourceConnectorType_S3 :: SourceConnectorType | |
pattern SourceConnectorType_Salesforce :: SourceConnectorType | |
pattern SourceConnectorType_Servicenow :: SourceConnectorType | |
pattern SourceConnectorType_Zendesk :: SourceConnectorType |
Instances
StandardIdentifier
newtype StandardIdentifier Source #
pattern StandardIdentifier_ASSET :: StandardIdentifier | |
pattern StandardIdentifier_CASE :: StandardIdentifier | |
pattern StandardIdentifier_LOOKUP_ONLY :: StandardIdentifier | |
pattern StandardIdentifier_NEW_ONLY :: StandardIdentifier | |
pattern StandardIdentifier_PROFILE :: StandardIdentifier | |
pattern StandardIdentifier_SECONDARY :: StandardIdentifier | |
pattern StandardIdentifier_UNIQUE :: StandardIdentifier |
Instances
TaskType
pattern TaskType_Arithmetic :: TaskType | |
pattern TaskType_Filter :: TaskType | |
pattern TaskType_Map :: TaskType | |
pattern TaskType_Mask :: TaskType | |
pattern TaskType_Merge :: TaskType | |
pattern TaskType_Truncate :: TaskType | |
pattern TaskType_Validate :: TaskType |
Instances
TriggerType
newtype TriggerType Source #
pattern TriggerType_Event :: TriggerType | |
pattern TriggerType_OnDemand :: TriggerType | |
pattern TriggerType_Scheduled :: TriggerType |
Instances
ZendeskConnectorOperator
newtype ZendeskConnectorOperator Source #
Instances
Address
A generic address associated with the customer that is not mailing, shipping, or billing.
See: newAddress
smart constructor.
Address' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newAddress :: Address Source #
Create a value of Address
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address2:Address'
, address_address2
- The second line of a customer address.
$sel:state:Address'
, address_state
- The state in which a customer lives.
$sel:address4:Address'
, address_address4
- The fourth line of a customer address.
$sel:county:Address'
, address_county
- The county in which a customer lives.
$sel:address3:Address'
, address_address3
- The third line of a customer address.
$sel:postalCode:Address'
, address_postalCode
- The postal code of a customer address.
$sel:country:Address'
, address_country
- The country in which a customer lives.
$sel:city:Address'
, address_city
- The city in which a customer lives.
$sel:address1:Address'
, address_address1
- The first line of a customer address.
$sel:province:Address'
, address_province
- The province in which a customer lives.
ConnectorOperator
data ConnectorOperator Source #
The operation to be performed on the provided source fields.
See: newConnectorOperator
smart constructor.
ConnectorOperator' (Maybe ServiceNowConnectorOperator) (Maybe MarketoConnectorOperator) (Maybe SalesforceConnectorOperator) (Maybe ZendeskConnectorOperator) (Maybe S3ConnectorOperator) |
Instances
newConnectorOperator :: ConnectorOperator Source #
Create a value of ConnectorOperator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceNow:ConnectorOperator'
, connectorOperator_serviceNow
- The operation to be performed on the provided ServiceNow source fields.
$sel:marketo:ConnectorOperator'
, connectorOperator_marketo
- The operation to be performed on the provided Marketo source fields.
$sel:salesforce:ConnectorOperator'
, connectorOperator_salesforce
- The operation to be performed on the provided Salesforce source fields.
$sel:zendesk:ConnectorOperator'
, connectorOperator_zendesk
- The operation to be performed on the provided Zendesk source fields.
$sel:s3:ConnectorOperator'
, connectorOperator_s3
- The operation to be performed on the provided Amazon S3 source fields.
DomainStats
data DomainStats Source #
Usage-specific statistics about the domain.
See: newDomainStats
smart constructor.
Instances
newDomainStats :: DomainStats Source #
Create a value of DomainStats
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:meteringProfileCount:DomainStats'
, domainStats_meteringProfileCount
- 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.
$sel:totalSize:DomainStats'
, domainStats_totalSize
- The total size, in bytes, of all objects in the domain.
$sel:profileCount:DomainStats'
, domainStats_profileCount
- The total number of profiles currently in the domain.
$sel:objectCount:DomainStats'
, domainStats_objectCount
- The total number of objects in domain.
FieldSourceProfileIds
data FieldSourceProfileIds Source #
A duplicate customer profile that is to be merged into a main profile.
See: newFieldSourceProfileIds
smart constructor.
FieldSourceProfileIds' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newFieldSourceProfileIds :: FieldSourceProfileIds Source #
Create a value of FieldSourceProfileIds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_shippingAddress
- A unique identifier for the shipping address field to be merged.
$sel:mobilePhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_mobilePhoneNumber
- A unique identifier for the mobile phone number field to be merged.
$sel:mailingAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_mailingAddress
- A unique identifier for the mailing address field to be merged.
$sel:middleName:FieldSourceProfileIds'
, fieldSourceProfileIds_middleName
- A unique identifier for the middle name field to be merged.
$sel:personalEmailAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_personalEmailAddress
- A unique identifier for the personal email address field to be merged.
$sel:lastName:FieldSourceProfileIds'
, fieldSourceProfileIds_lastName
- A unique identifier for the last name field to be merged.
$sel:additionalInformation:FieldSourceProfileIds'
, fieldSourceProfileIds_additionalInformation
- A unique identifier for the additional information field to be merged.
$sel:homePhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_homePhoneNumber
- A unique identifier for the home phone number field to be merged.
$sel:address:FieldSourceProfileIds'
, fieldSourceProfileIds_address
- A unique identifier for the party type field to be merged.
$sel:partyType:FieldSourceProfileIds'
, fieldSourceProfileIds_partyType
- A unique identifier for the party type field to be merged.
$sel:businessEmailAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_businessEmailAddress
- A unique identifier for the party type field to be merged.
$sel:attributes:FieldSourceProfileIds'
, fieldSourceProfileIds_attributes
- A unique identifier for the attributes field to be merged.
$sel:gender:FieldSourceProfileIds'
, fieldSourceProfileIds_gender
- A unique identifier for the gender field to be merged.
$sel:phoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_phoneNumber
- A unique identifier for the phone number field to be merged.
$sel:accountNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_accountNumber
- A unique identifier for the account number field to be merged.
$sel:emailAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_emailAddress
- A unique identifier for the email address field to be merged.
$sel:firstName:FieldSourceProfileIds'
, fieldSourceProfileIds_firstName
- A unique identifier for the first name field to be merged.
$sel:billingAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_billingAddress
- A unique identifier for the billing type field to be merged.
$sel:businessPhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_businessPhoneNumber
- A unique identifier for the business phone number field to be merged.
$sel:birthDate:FieldSourceProfileIds'
, fieldSourceProfileIds_birthDate
- A unique identifier for the birthdate field to be merged.
$sel:businessName:FieldSourceProfileIds'
, fieldSourceProfileIds_businessName
- A unique identifier for the business name field to be merged.
FlowDefinition
data FlowDefinition Source #
The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
See: newFlowDefinition
smart constructor.
Instances
:: Text | |
-> Text | |
-> SourceFlowConfig | |
-> TriggerConfig | |
-> FlowDefinition |
Create a value of FlowDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:FlowDefinition'
, flowDefinition_description
- A description of the flow you want to create.
$sel:flowName:FlowDefinition'
, flowDefinition_flowName
- The specified name of the flow. Use underscores (_) or hyphens (-) only.
Spaces are not allowed.
$sel:kmsArn:FlowDefinition'
, flowDefinition_kmsArn
- The Amazon Resource Name of the AWS Key Management Service (KMS) key you
provide for encryption.
$sel:sourceFlowConfig:FlowDefinition'
, flowDefinition_sourceFlowConfig
- The configuration that controls how Customer Profiles retrieves data
from the source.
$sel:tasks:FlowDefinition'
, flowDefinition_tasks
- A list of tasks that Customer Profiles performs while transferring the
data in the flow run.
$sel:triggerConfig:FlowDefinition'
, flowDefinition_triggerConfig
- The trigger settings that determine how and when the flow runs.
IncrementalPullConfig
data IncrementalPullConfig Source #
Specifies the configuration used when importing incremental records from the source.
See: newIncrementalPullConfig
smart constructor.
Instances
newIncrementalPullConfig :: IncrementalPullConfig Source #
Create a value of IncrementalPullConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datetimeTypeFieldName:IncrementalPullConfig'
, incrementalPullConfig_datetimeTypeFieldName
- A field that specifies the date time or timestamp field as the criteria
to use when importing incremental records from the source.
ListDomainItem
data ListDomainItem Source #
An object in a list that represents a domain.
See: newListDomainItem
smart constructor.
Instances
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> ListDomainItem |
Create a value of ListDomainItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListDomainItem'
, listDomainItem_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:ListDomainItem'
, listDomainItem_domainName
- The unique name of the domain.
$sel:createdAt:ListDomainItem'
, listDomainItem_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:ListDomainItem'
, listDomainItem_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
ListIntegrationItem
data ListIntegrationItem Source #
An integration in list of integrations.
See: newListIntegrationItem
smart constructor.
Instances
newListIntegrationItem Source #
Create a value of ListIntegrationItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListIntegrationItem'
, listIntegrationItem_tags
- The tags used to organize, track, or control access for this resource.
$sel:domainName:ListIntegrationItem'
, listIntegrationItem_domainName
- The unique name of the domain.
$sel:uri:ListIntegrationItem'
, listIntegrationItem_uri
- The URI of the S3 bucket or any other type of data source.
$sel:objectTypeName:ListIntegrationItem'
, listIntegrationItem_objectTypeName
- The name of the profile object type.
$sel:createdAt:ListIntegrationItem'
, listIntegrationItem_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:ListIntegrationItem'
, listIntegrationItem_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
ListProfileObjectTypeItem
data ListProfileObjectTypeItem Source #
A ProfileObjectType instance.
See: newListProfileObjectTypeItem
smart constructor.
Instances
newListProfileObjectTypeItem Source #
:: Text | |
-> Text | |
-> ListProfileObjectTypeItem |
Create a value of ListProfileObjectTypeItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedAt:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
$sel:createdAt:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_createdAt
- The timestamp of when the domain was created.
$sel:tags:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_tags
- The tags used to organize, track, or control access for this resource.
$sel:objectTypeName:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_objectTypeName
- The name of the profile object type.
$sel:description:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_description
- Description of the profile object type.
ListProfileObjectTypeTemplateItem
data ListProfileObjectTypeTemplateItem Source #
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
See: newListProfileObjectTypeTemplateItem
smart constructor.
Instances
newListProfileObjectTypeTemplateItem :: ListProfileObjectTypeTemplateItem Source #
Create a value of ListProfileObjectTypeTemplateItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceName:ListProfileObjectTypeTemplateItem'
, listProfileObjectTypeTemplateItem_sourceName
- The name of the source of the object template.
$sel:templateId:ListProfileObjectTypeTemplateItem'
, listProfileObjectTypeTemplateItem_templateId
- A unique identifier for the object template.
$sel:sourceObject:ListProfileObjectTypeTemplateItem'
, listProfileObjectTypeTemplateItem_sourceObject
- The source of the object template.
ListProfileObjectsItem
data ListProfileObjectsItem Source #
A ProfileObject in a list of ProfileObjects.
See: newListProfileObjectsItem
smart constructor.
Instances
newListProfileObjectsItem :: ListProfileObjectsItem Source #
Create a value of ListProfileObjectsItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileObjectUniqueKey:ListProfileObjectsItem'
, listProfileObjectsItem_profileObjectUniqueKey
- The unique identifier of the ProfileObject generated by the service.
$sel:objectTypeName:ListProfileObjectsItem'
, listProfileObjectsItem_objectTypeName
- Specifies the kind of object being added to a profile, such as
"Salesforce-Account."
$sel:object':ListProfileObjectsItem'
, listProfileObjectsItem_object
- A JSON representation of a ProfileObject that belongs to a profile.
MarketoSourceProperties
data MarketoSourceProperties Source #
The properties that are applied when Marketo is being used as a source.
See: newMarketoSourceProperties
smart constructor.
Instances
newMarketoSourceProperties Source #
Create a value of MarketoSourceProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:object':MarketoSourceProperties'
, marketoSourceProperties_object
- The object specified in the Marketo flow source.
MatchItem
The Match group object.
See: newMatchItem
smart constructor.
MatchItem' (Maybe [Text]) (Maybe Text) |
Instances
Eq MatchItem Source # | |
Read MatchItem Source # | |
Show MatchItem Source # | |
Generic MatchItem Source # | |
NFData MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
Hashable MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
FromJSON MatchItem Source # | |
type Rep MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem type Rep MatchItem = D1 ('MetaData "MatchItem" "Amazonka.CustomerProfiles.Types.MatchItem" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "MatchItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "profileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "matchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newMatchItem :: MatchItem Source #
Create a value of MatchItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileIds:MatchItem'
, matchItem_profileIds
- A list of identifiers for profiles that match.
$sel:matchId:MatchItem'
, matchItem_matchId
- The unique identifiers for this group of profiles that match.
MatchingRequest
data MatchingRequest Source #
The flag that enables the matching process of duplicate profiles.
See: newMatchingRequest
smart constructor.
Instances
Create a value of MatchingRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:MatchingRequest'
, matchingRequest_enabled
- The flag that enables the matching process of duplicate profiles.
MatchingResponse
data MatchingResponse Source #
The flag that enables the matching process of duplicate profiles.
See: newMatchingResponse
smart constructor.
Instances
newMatchingResponse :: MatchingResponse Source #
Create a value of MatchingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:MatchingResponse'
, matchingResponse_enabled
- The flag that enables the matching process of duplicate profiles.
ObjectFilter
data ObjectFilter Source #
The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset and _case.
See: newObjectFilter
smart constructor.
Instances
Create a value of ObjectFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyName:ObjectFilter'
, objectFilter_keyName
- 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.
$sel:values:ObjectFilter'
, objectFilter_values
- A list of key values.
ObjectTypeField
data ObjectTypeField Source #
Represents a field in a ProfileObjectType.
See: newObjectTypeField
smart constructor.
Instances
newObjectTypeField :: ObjectTypeField Source #
Create a value of ObjectTypeField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:source:ObjectTypeField'
, objectTypeField_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.
$sel:contentType:ObjectTypeField'
, objectTypeField_contentType
- The content type of the field. Used for determining equality when
searching.
$sel:target:ObjectTypeField'
, objectTypeField_target
- The location of the data in the standard ProfileObject model. For
example: _profile.Address.PostalCode.
ObjectTypeKey
data ObjectTypeKey Source #
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
See: newObjectTypeKey
smart constructor.
ObjectTypeKey' (Maybe [Text]) (Maybe [StandardIdentifier]) |
Instances
newObjectTypeKey :: ObjectTypeKey Source #
Create a value of ObjectTypeKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldNames:ObjectTypeKey'
, objectTypeKey_fieldNames
- The reference for the key name of the fields map.
$sel:standardIdentifiers:ObjectTypeKey'
, objectTypeKey_standardIdentifiers
- 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
The standard profile of a customer.
See: newProfile
smart constructor.
Profile' (Maybe Address) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newProfile :: Profile Source #
Create a value of Profile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:Profile'
, profile_shippingAddress
- The customer’s shipping address.
$sel:mobilePhoneNumber:Profile'
, profile_mobilePhoneNumber
- The customer’s mobile phone number.
$sel:mailingAddress:Profile'
, profile_mailingAddress
- The customer’s mailing address.
$sel:middleName:Profile'
, profile_middleName
- The customer’s middle name.
$sel:personalEmailAddress:Profile'
, profile_personalEmailAddress
- The customer’s personal email address.
$sel:lastName:Profile'
, profile_lastName
- The customer’s last name.
$sel:additionalInformation:Profile'
, profile_additionalInformation
- Any additional information relevant to the customer’s profile.
$sel:homePhoneNumber:Profile'
, profile_homePhoneNumber
- The customer’s home phone number.
$sel:address:Profile'
, profile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
$sel:partyType:Profile'
, profile_partyType
- The type of profile used to describe the customer.
$sel:profileId:Profile'
, profile_profileId
- The unique identifier of a customer profile.
$sel:businessEmailAddress:Profile'
, profile_businessEmailAddress
- The customer’s business email address.
$sel:attributes:Profile'
, profile_attributes
- A key value pair of attributes of a customer profile.
$sel:gender:Profile'
, profile_gender
- The gender with which the customer identifies.
$sel:phoneNumber:Profile'
, profile_phoneNumber
- The customer's phone number, which has not been specified as a mobile,
home, or business number.
$sel:accountNumber:Profile'
, profile_accountNumber
- A unique account number that you have given to the customer.
$sel:emailAddress:Profile'
, profile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
$sel:firstName:Profile'
, profile_firstName
- The customer’s first name.
$sel:billingAddress:Profile'
, profile_billingAddress
- The customer’s billing address.
$sel:businessPhoneNumber:Profile'
, profile_businessPhoneNumber
- The customer’s home phone number.
$sel:birthDate:Profile'
, profile_birthDate
- The customer’s birth date.
$sel:businessName:Profile'
, profile_businessName
- The name of the customer’s business.
S3SourceProperties
data S3SourceProperties Source #
The properties that are applied when Amazon S3 is being used as the flow source.
See: newS3SourceProperties
smart constructor.
Instances
newS3SourceProperties Source #
Create a value of S3SourceProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketPrefix:S3SourceProperties'
, s3SourceProperties_bucketPrefix
- The object key for the Amazon S3 bucket in which the source files are
stored.
$sel:bucketName:S3SourceProperties'
, s3SourceProperties_bucketName
- The Amazon S3 bucket name where the source files are stored.
SalesforceSourceProperties
data SalesforceSourceProperties Source #
The properties that are applied when Salesforce is being used as a source.
See: newSalesforceSourceProperties
smart constructor.
Instances
newSalesforceSourceProperties Source #
Create a value of SalesforceSourceProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enableDynamicFieldUpdate:SalesforceSourceProperties'
, salesforceSourceProperties_enableDynamicFieldUpdate
- The flag that enables dynamic fetching of new (recently added) fields in
the Salesforce objects while running a flow.
$sel:includeDeletedRecords:SalesforceSourceProperties'
, salesforceSourceProperties_includeDeletedRecords
- Indicates whether Amazon AppFlow includes deleted files in the flow run.
$sel:object':SalesforceSourceProperties'
, salesforceSourceProperties_object
- The object specified in the Salesforce flow source.
ScheduledTriggerProperties
data ScheduledTriggerProperties Source #
Specifies the configuration details of a scheduled-trigger flow that you define. Currently, these settings only apply to the scheduled-trigger type.
See: newScheduledTriggerProperties
smart constructor.
ScheduledTriggerProperties' (Maybe POSIX) (Maybe Natural) (Maybe DataPullMode) (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text |
Instances
newScheduledTriggerProperties Source #
Create a value of ScheduledTriggerProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleEndTime:ScheduledTriggerProperties'
, scheduledTriggerProperties_scheduleEndTime
- Specifies the scheduled end time for a scheduled-trigger flow.
$sel:scheduleOffset:ScheduledTriggerProperties'
, scheduledTriggerProperties_scheduleOffset
- Specifies the optional offset that is added to the time interval for a
schedule-triggered flow.
$sel:dataPullMode:ScheduledTriggerProperties'
, scheduledTriggerProperties_dataPullMode
- Specifies whether a scheduled flow has an incremental data transfer or a
complete data transfer for each flow run.
$sel:scheduleStartTime:ScheduledTriggerProperties'
, scheduledTriggerProperties_scheduleStartTime
- Specifies the scheduled start time for a scheduled-trigger flow.
$sel:timezone:ScheduledTriggerProperties'
, scheduledTriggerProperties_timezone
- Specifies the time zone used when referring to the date and time of a
scheduled-triggered flow, such as America/New_York.
$sel:firstExecutionFrom:ScheduledTriggerProperties'
, scheduledTriggerProperties_firstExecutionFrom
- Specifies the date range for the records to import from the connector in
the first flow run.
$sel:scheduleExpression:ScheduledTriggerProperties'
, scheduledTriggerProperties_scheduleExpression
- The scheduling expression that determines the rate at which the schedule
will run, for example rate (5 minutes).
ServiceNowSourceProperties
data ServiceNowSourceProperties Source #
The properties that are applied when ServiceNow is being used as a source.
See: newServiceNowSourceProperties
smart constructor.
Instances
newServiceNowSourceProperties Source #
Create a value of ServiceNowSourceProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:object':ServiceNowSourceProperties'
, serviceNowSourceProperties_object
- The object specified in the ServiceNow flow source.
SourceConnectorProperties
data SourceConnectorProperties Source #
Specifies the information that is required to query a particular Amazon AppFlow connector. Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
See: newSourceConnectorProperties
smart constructor.
SourceConnectorProperties' (Maybe ServiceNowSourceProperties) (Maybe MarketoSourceProperties) (Maybe SalesforceSourceProperties) (Maybe ZendeskSourceProperties) (Maybe S3SourceProperties) |
Instances
newSourceConnectorProperties :: SourceConnectorProperties Source #
Create a value of SourceConnectorProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceNow:SourceConnectorProperties'
, sourceConnectorProperties_serviceNow
- The properties that are applied when ServiceNow is being used as a
source.
$sel:marketo:SourceConnectorProperties'
, sourceConnectorProperties_marketo
- The properties that are applied when Marketo is being used as a source.
$sel:salesforce:SourceConnectorProperties'
, sourceConnectorProperties_salesforce
- The properties that are applied when Salesforce is being used as a
source.
$sel:zendesk:SourceConnectorProperties'
, sourceConnectorProperties_zendesk
- The properties that are applied when using Zendesk as a flow source.
$sel:s3:SourceConnectorProperties'
, sourceConnectorProperties_s3
- The properties that are applied when Amazon S3 is being used as the flow
source.
SourceFlowConfig
data SourceFlowConfig Source #
Contains information about the configuration of the source connector used in the flow.
See: newSourceFlowConfig
smart constructor.
SourceFlowConfig' (Maybe Text) (Maybe IncrementalPullConfig) SourceConnectorType SourceConnectorProperties |
Instances
Create a value of SourceFlowConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectorProfileName:SourceFlowConfig'
, sourceFlowConfig_connectorProfileName
- The name of the AppFlow connector profile. This name must be unique for
each connector profile in the AWS account.
$sel:incrementalPullConfig:SourceFlowConfig'
, sourceFlowConfig_incrementalPullConfig
- 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.
$sel:connectorType:SourceFlowConfig'
, sourceFlowConfig_connectorType
- The type of connector, such as Salesforce, Marketo, and so on.
$sel:sourceConnectorProperties:SourceFlowConfig'
, sourceFlowConfig_sourceConnectorProperties
- Specifies the information that is required to query a particular source
connector.
Task
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
See: newTask
smart constructor.
Task' (Maybe (HashMap OperatorPropertiesKeys Text)) (Maybe ConnectorOperator) (Maybe Text) [Text] TaskType |
Instances
Create a value of Task
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:taskProperties:Task'
, task_taskProperties
- A map used to store task-related information. The service looks for
particular information based on the TaskType.
$sel:connectorOperator:Task'
, task_connectorOperator
- The operation to be performed on the provided source fields.
$sel:destinationField:Task'
, task_destinationField
- A field in a destination connector, or a field value against which
Amazon AppFlow validates a source field.
$sel:sourceFields:Task'
, task_sourceFields
- The source fields to which a particular task is applied.
$sel:taskType:Task'
, task_taskType
- Specifies the particular task implementation that Amazon AppFlow
performs.
TriggerConfig
data TriggerConfig Source #
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
See: newTriggerConfig
smart constructor.
Instances
Create a value of TriggerConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:triggerProperties:TriggerConfig'
, triggerConfig_triggerProperties
- Specifies the configuration details of a schedule-triggered flow that
you define. Currently, these settings only apply to the Scheduled
trigger type.
$sel:triggerType:TriggerConfig'
, triggerConfig_triggerType
- Specifies the type of flow trigger. It can be OnDemand, Scheduled, or
Event.
TriggerProperties
data TriggerProperties Source #
Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
See: newTriggerProperties
smart constructor.
Instances
newTriggerProperties :: TriggerProperties Source #
Create a value of TriggerProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduled:TriggerProperties'
, triggerProperties_scheduled
- Specifies the configuration details of a schedule-triggered flow that
you define.
UpdateAddress
data UpdateAddress Source #
Updates associated with the address properties of a customer profile.
See: newUpdateAddress
smart constructor.
UpdateAddress' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newUpdateAddress :: UpdateAddress Source #
Create a value of UpdateAddress
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address2:UpdateAddress'
, updateAddress_address2
- The second line of a customer address.
$sel:state:UpdateAddress'
, updateAddress_state
- The state in which a customer lives.
$sel:address4:UpdateAddress'
, updateAddress_address4
- The fourth line of a customer address.
$sel:county:UpdateAddress'
, updateAddress_county
- The county in which a customer lives.
$sel:address3:UpdateAddress'
, updateAddress_address3
- The third line of a customer address.
$sel:postalCode:UpdateAddress'
, updateAddress_postalCode
- The postal code of a customer address.
$sel:country:UpdateAddress'
, updateAddress_country
- The country in which a customer lives.
$sel:city:UpdateAddress'
, updateAddress_city
- The city in which a customer lives.
$sel:address1:UpdateAddress'
, updateAddress_address1
- The first line of a customer address.
$sel:province:UpdateAddress'
, updateAddress_province
- The province in which a customer lives.
ZendeskSourceProperties
data ZendeskSourceProperties Source #
The properties that are applied when using Zendesk as a flow source.
See: newZendeskSourceProperties
smart constructor.
Instances
newZendeskSourceProperties Source #
Create a value of ZendeskSourceProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:object':ZendeskSourceProperties'
, zendeskSourceProperties_object
- The object specified in the Zendesk flow source.