Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AddProfileKey
- CreateDomain
- CreateIntegrationWorkflow
- CreateProfile
- DeleteDomain
- DeleteIntegration
- DeleteProfile
- DeleteProfileKey
- DeleteProfileObject
- DeleteProfileObjectType
- DeleteWorkflow
- GetAutoMergingPreview
- GetDomain
- GetIdentityResolutionJob
- GetIntegration
- GetMatches
- GetProfileObjectType
- GetProfileObjectTypeTemplate
- GetWorkflow
- GetWorkflowSteps
- ListAccountIntegrations
- ListDomains
- ListIdentityResolutionJobs
- ListIntegrations
- ListProfileObjectTypeTemplates
- ListProfileObjectTypes
- ListProfileObjects
- ListTagsForResource
- ListWorkflows
- MergeProfiles
- PutIntegration
- PutProfileObject
- PutProfileObjectType
- SearchProfiles
- TagResource
- UntagResource
- UpdateDomain
- UpdateProfile
- Types
- ConflictResolvingModel
- DataPullMode
- FieldContentType
- Gender
- IdentityResolutionJobStatus
- JobScheduleDayOfTheWeek
- LogicalOperator
- MarketoConnectorOperator
- OperatorPropertiesKeys
- PartyType
- S3ConnectorOperator
- SalesforceConnectorOperator
- ServiceNowConnectorOperator
- SourceConnectorType
- StandardIdentifier
- Status
- TaskType
- TriggerType
- WorkflowType
- ZendeskConnectorOperator
- AdditionalSearchKey
- Address
- AppflowIntegration
- AppflowIntegrationWorkflowAttributes
- AppflowIntegrationWorkflowMetrics
- AppflowIntegrationWorkflowStep
- AutoMerging
- Batch
- ConflictResolution
- ConnectorOperator
- Consolidation
- DomainStats
- ExportingConfig
- ExportingLocation
- FieldSourceProfileIds
- FlowDefinition
- FoundByKeyValue
- IdentityResolutionJob
- IncrementalPullConfig
- IntegrationConfig
- JobSchedule
- JobStats
- ListDomainItem
- ListIntegrationItem
- ListProfileObjectTypeItem
- ListProfileObjectTypeTemplateItem
- ListProfileObjectsItem
- ListWorkflowsItem
- MarketoSourceProperties
- MatchItem
- MatchingRequest
- MatchingResponse
- ObjectFilter
- ObjectTypeField
- ObjectTypeKey
- Profile
- S3ExportingConfig
- S3ExportingLocation
- S3SourceProperties
- SalesforceSourceProperties
- ScheduledTriggerProperties
- ServiceNowSourceProperties
- SourceConnectorProperties
- SourceFlowConfig
- Task
- TriggerConfig
- TriggerProperties
- UpdateAddress
- WorkflowAttributes
- WorkflowMetrics
- WorkflowStepItem
- ZendeskSourceProperties
Derived from API version 2020-08-15
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Connect Customer Profiles
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 review the Amazon Connect Administrator Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- data AddProfileKey = AddProfileKey' Text Text [Text] Text
- newAddProfileKey :: Text -> Text -> Text -> AddProfileKey
- data AddProfileKeyResponse = AddProfileKeyResponse' (Maybe Text) (Maybe [Text]) Int
- newAddProfileKeyResponse :: Int -> AddProfileKeyResponse
- data CreateDomain = CreateDomain' (Maybe Text) (Maybe Text) (Maybe MatchingRequest) (Maybe (HashMap Text Text)) Text Natural
- newCreateDomain :: Text -> Natural -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe Text) (Maybe Text) (Maybe MatchingResponse) (Maybe (HashMap Text Text)) Int Text Natural POSIX POSIX
- newCreateDomainResponse :: Int -> Text -> Natural -> UTCTime -> UTCTime -> CreateDomainResponse
- data CreateIntegrationWorkflow = CreateIntegrationWorkflow' (Maybe (HashMap Text Text)) Text WorkflowType IntegrationConfig Text Text
- newCreateIntegrationWorkflow :: Text -> WorkflowType -> IntegrationConfig -> Text -> Text -> CreateIntegrationWorkflow
- data CreateIntegrationWorkflowResponse = CreateIntegrationWorkflowResponse' Int Text Text
- newCreateIntegrationWorkflowResponse :: Int -> Text -> Text -> CreateIntegrationWorkflowResponse
- data CreateProfile = CreateProfile' (Maybe Text) (Maybe Text) (Maybe Address) (Maybe (HashMap Text Text)) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) Text
- newCreateProfile :: Text -> CreateProfile
- data CreateProfileResponse = CreateProfileResponse' Int Text
- newCreateProfileResponse :: Int -> Text -> CreateProfileResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' Int Text
- newDeleteDomainResponse :: Int -> Text -> DeleteDomainResponse
- data DeleteIntegration = DeleteIntegration' Text Text
- newDeleteIntegration :: Text -> Text -> DeleteIntegration
- data DeleteIntegrationResponse = DeleteIntegrationResponse' Int Text
- newDeleteIntegrationResponse :: Int -> Text -> DeleteIntegrationResponse
- data DeleteProfile = DeleteProfile' Text Text
- newDeleteProfile :: Text -> Text -> DeleteProfile
- data DeleteProfileResponse = DeleteProfileResponse' (Maybe Text) Int
- newDeleteProfileResponse :: Int -> DeleteProfileResponse
- data DeleteProfileKey = DeleteProfileKey' Text Text [Text] Text
- newDeleteProfileKey :: Text -> Text -> Text -> DeleteProfileKey
- data DeleteProfileKeyResponse = DeleteProfileKeyResponse' (Maybe Text) Int
- newDeleteProfileKeyResponse :: Int -> DeleteProfileKeyResponse
- data DeleteProfileObject = DeleteProfileObject' Text Text Text Text
- newDeleteProfileObject :: Text -> Text -> Text -> Text -> DeleteProfileObject
- data DeleteProfileObjectResponse = DeleteProfileObjectResponse' (Maybe Text) Int
- newDeleteProfileObjectResponse :: Int -> DeleteProfileObjectResponse
- data DeleteProfileObjectType = DeleteProfileObjectType' Text Text
- newDeleteProfileObjectType :: Text -> Text -> DeleteProfileObjectType
- data DeleteProfileObjectTypeResponse = DeleteProfileObjectTypeResponse' Int Text
- newDeleteProfileObjectTypeResponse :: Int -> Text -> DeleteProfileObjectTypeResponse
- data DeleteWorkflow = DeleteWorkflow' Text Text
- newDeleteWorkflow :: Text -> Text -> DeleteWorkflow
- data DeleteWorkflowResponse = DeleteWorkflowResponse' Int
- newDeleteWorkflowResponse :: Int -> DeleteWorkflowResponse
- data GetAutoMergingPreview = GetAutoMergingPreview' (Maybe Double) Text Consolidation ConflictResolution
- newGetAutoMergingPreview :: Text -> Consolidation -> ConflictResolution -> GetAutoMergingPreview
- data GetAutoMergingPreviewResponse = GetAutoMergingPreviewResponse' (Maybe Integer) (Maybe Integer) (Maybe Integer) Int Text
- newGetAutoMergingPreviewResponse :: Int -> Text -> GetAutoMergingPreviewResponse
- data GetDomain = GetDomain' Text
- newGetDomain :: Text -> GetDomain
- data GetDomainResponse = GetDomainResponse' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingResponse) (Maybe DomainStats) (Maybe (HashMap Text Text)) Int Text POSIX POSIX
- newGetDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> GetDomainResponse
- data GetIdentityResolutionJob = GetIdentityResolutionJob' Text Text
- newGetIdentityResolutionJob :: Text -> Text -> GetIdentityResolutionJob
- data GetIdentityResolutionJobResponse = GetIdentityResolutionJobResponse' (Maybe AutoMerging) (Maybe Text) (Maybe ExportingLocation) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe JobStats) (Maybe POSIX) (Maybe Text) (Maybe IdentityResolutionJobStatus) Int
- newGetIdentityResolutionJobResponse :: Int -> GetIdentityResolutionJobResponse
- data GetIntegration = GetIntegration' Text Text
- newGetIntegration :: Text -> Text -> GetIntegration
- data GetIntegrationResponse = GetIntegrationResponse' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text POSIX POSIX
- newGetIntegrationResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> GetIntegrationResponse
- data GetMatches = GetMatches' (Maybe Natural) (Maybe Text) Text
- newGetMatches :: Text -> GetMatches
- data GetMatchesResponse = GetMatchesResponse' (Maybe POSIX) (Maybe [MatchItem]) (Maybe Text) (Maybe Natural) Int
- newGetMatchesResponse :: Int -> GetMatchesResponse
- data GetProfileObjectType = GetProfileObjectType' Text Text
- newGetProfileObjectType :: Text -> Text -> GetProfileObjectType
- data GetProfileObjectTypeResponse = GetProfileObjectTypeResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text
- newGetProfileObjectTypeResponse :: Int -> Text -> Text -> GetProfileObjectTypeResponse
- data GetProfileObjectTypeTemplate = GetProfileObjectTypeTemplate' Text
- newGetProfileObjectTypeTemplate :: Text -> GetProfileObjectTypeTemplate
- data GetProfileObjectTypeTemplateResponse = GetProfileObjectTypeTemplateResponse' (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetProfileObjectTypeTemplateResponse :: Int -> GetProfileObjectTypeTemplateResponse
- data GetWorkflow = GetWorkflow' Text Text
- newGetWorkflow :: Text -> Text -> GetWorkflow
- data GetWorkflowResponse = GetWorkflowResponse' (Maybe WorkflowAttributes) (Maybe Text) (Maybe POSIX) (Maybe WorkflowMetrics) (Maybe POSIX) (Maybe Status) (Maybe Text) (Maybe WorkflowType) Int
- newGetWorkflowResponse :: Int -> GetWorkflowResponse
- data GetWorkflowSteps = GetWorkflowSteps' (Maybe Natural) (Maybe Text) Text Text
- newGetWorkflowSteps :: Text -> Text -> GetWorkflowSteps
- data GetWorkflowStepsResponse = GetWorkflowStepsResponse' (Maybe [WorkflowStepItem]) (Maybe Text) (Maybe Text) (Maybe WorkflowType) Int
- newGetWorkflowStepsResponse :: Int -> GetWorkflowStepsResponse
- data ListAccountIntegrations = ListAccountIntegrations' (Maybe Bool) (Maybe Natural) (Maybe Text) Text
- newListAccountIntegrations :: Text -> ListAccountIntegrations
- data ListAccountIntegrationsResponse = ListAccountIntegrationsResponse' (Maybe [ListIntegrationItem]) (Maybe Text) Int
- newListAccountIntegrationsResponse :: Int -> ListAccountIntegrationsResponse
- data ListDomains = ListDomains' (Maybe Natural) (Maybe Text)
- newListDomains :: ListDomains
- data ListDomainsResponse = ListDomainsResponse' (Maybe [ListDomainItem]) (Maybe Text) Int
- newListDomainsResponse :: Int -> ListDomainsResponse
- data ListIdentityResolutionJobs = ListIdentityResolutionJobs' (Maybe Natural) (Maybe Text) Text
- newListIdentityResolutionJobs :: Text -> ListIdentityResolutionJobs
- data ListIdentityResolutionJobsResponse = ListIdentityResolutionJobsResponse' (Maybe [IdentityResolutionJob]) (Maybe Text) Int
- newListIdentityResolutionJobsResponse :: Int -> ListIdentityResolutionJobsResponse
- data ListIntegrations = ListIntegrations' (Maybe Bool) (Maybe Natural) (Maybe Text) Text
- newListIntegrations :: Text -> ListIntegrations
- data ListIntegrationsResponse = ListIntegrationsResponse' (Maybe [ListIntegrationItem]) (Maybe Text) Int
- newListIntegrationsResponse :: Int -> ListIntegrationsResponse
- data ListProfileObjectTypeTemplates = ListProfileObjectTypeTemplates' (Maybe Natural) (Maybe Text)
- newListProfileObjectTypeTemplates :: ListProfileObjectTypeTemplates
- data ListProfileObjectTypeTemplatesResponse = ListProfileObjectTypeTemplatesResponse' (Maybe [ListProfileObjectTypeTemplateItem]) (Maybe Text) Int
- newListProfileObjectTypeTemplatesResponse :: Int -> ListProfileObjectTypeTemplatesResponse
- data ListProfileObjectTypes = ListProfileObjectTypes' (Maybe Natural) (Maybe Text) Text
- newListProfileObjectTypes :: Text -> ListProfileObjectTypes
- data ListProfileObjectTypesResponse = ListProfileObjectTypesResponse' (Maybe [ListProfileObjectTypeItem]) (Maybe Text) Int
- newListProfileObjectTypesResponse :: Int -> ListProfileObjectTypesResponse
- data ListProfileObjects = ListProfileObjects' (Maybe Natural) (Maybe Text) (Maybe ObjectFilter) Text Text Text
- newListProfileObjects :: Text -> Text -> Text -> ListProfileObjects
- data ListProfileObjectsResponse = ListProfileObjectsResponse' (Maybe [ListProfileObjectsItem]) (Maybe Text) Int
- newListProfileObjectsResponse :: Int -> ListProfileObjectsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWorkflows = ListWorkflows' (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Status) (Maybe WorkflowType) Text
- newListWorkflows :: Text -> ListWorkflows
- data ListWorkflowsResponse = ListWorkflowsResponse' (Maybe [ListWorkflowsItem]) (Maybe Text) Int
- newListWorkflowsResponse :: Int -> ListWorkflowsResponse
- 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 PutIntegration = PutIntegration' (Maybe FlowDefinition) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text
- newPutIntegration :: Text -> PutIntegration
- data PutIntegrationResponse = PutIntegrationResponse' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text POSIX POSIX
- newPutIntegrationResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> PutIntegrationResponse
- data PutProfileObject = PutProfileObject' Text Text Text
- newPutProfileObject :: Text -> Text -> Text -> PutProfileObject
- data PutProfileObjectResponse = PutProfileObjectResponse' (Maybe Text) Int
- newPutProfileObjectResponse :: Int -> PutProfileObjectResponse
- data PutProfileObjectType = PutProfileObjectType' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text
- newPutProfileObjectType :: Text -> Text -> Text -> PutProfileObjectType
- data PutProfileObjectTypeResponse = PutProfileObjectTypeResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text
- newPutProfileObjectTypeResponse :: Int -> Text -> Text -> PutProfileObjectTypeResponse
- data SearchProfiles = SearchProfiles' (Maybe (NonEmpty AdditionalSearchKey)) (Maybe LogicalOperator) (Maybe Natural) (Maybe Text) Text Text [Text]
- newSearchProfiles :: Text -> Text -> SearchProfiles
- data SearchProfilesResponse = SearchProfilesResponse' (Maybe [Profile]) (Maybe Text) Int
- newSearchProfilesResponse :: Int -> SearchProfilesResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDomain = UpdateDomain' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingRequest) (Maybe (HashMap Text Text)) Text
- newUpdateDomain :: Text -> UpdateDomain
- data UpdateDomainResponse = UpdateDomainResponse' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingResponse) (Maybe (HashMap Text Text)) Int Text POSIX POSIX
- newUpdateDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> UpdateDomainResponse
- data UpdateProfile = UpdateProfile' (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe (HashMap Text Text)) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) Text Text
- newUpdateProfile :: Text -> Text -> UpdateProfile
- data UpdateProfileResponse = UpdateProfileResponse' Int Text
- newUpdateProfileResponse :: Int -> Text -> UpdateProfileResponse
- newtype ConflictResolvingModel where
- 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 IdentityResolutionJobStatus where
- IdentityResolutionJobStatus' { }
- pattern IdentityResolutionJobStatus_COMPLETED :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_FAILED :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_FIND_MATCHING :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_MERGING :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_PARTIAL_SUCCESS :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_PENDING :: IdentityResolutionJobStatus
- pattern IdentityResolutionJobStatus_PREPROCESSING :: IdentityResolutionJobStatus
- newtype JobScheduleDayOfTheWeek where
- JobScheduleDayOfTheWeek' { }
- pattern JobScheduleDayOfTheWeek_FRIDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_MONDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_SATURDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_SUNDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_THURSDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_TUESDAY :: JobScheduleDayOfTheWeek
- pattern JobScheduleDayOfTheWeek_WEDNESDAY :: JobScheduleDayOfTheWeek
- newtype LogicalOperator where
- LogicalOperator' { }
- pattern LogicalOperator_AND :: LogicalOperator
- pattern LogicalOperator_OR :: LogicalOperator
- 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_ORDER :: StandardIdentifier
- pattern StandardIdentifier_PROFILE :: StandardIdentifier
- pattern StandardIdentifier_SECONDARY :: StandardIdentifier
- pattern StandardIdentifier_UNIQUE :: StandardIdentifier
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_CANCELLED :: Status
- pattern Status_COMPLETE :: Status
- pattern Status_FAILED :: Status
- pattern Status_IN_PROGRESS :: Status
- pattern Status_NOT_STARTED :: Status
- pattern Status_RETRY :: Status
- pattern Status_SPLIT :: Status
- Status' {
- 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 WorkflowType where
- WorkflowType' { }
- pattern WorkflowType_APPFLOW_INTEGRATION :: WorkflowType
- 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 AdditionalSearchKey = AdditionalSearchKey' Text [Text]
- newAdditionalSearchKey :: Text -> AdditionalSearchKey
- 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 AppflowIntegration = AppflowIntegration' (Maybe [Batch]) FlowDefinition
- newAppflowIntegration :: FlowDefinition -> AppflowIntegration
- data AppflowIntegrationWorkflowAttributes = AppflowIntegrationWorkflowAttributes' (Maybe Text) SourceConnectorType Text
- newAppflowIntegrationWorkflowAttributes :: SourceConnectorType -> Text -> AppflowIntegrationWorkflowAttributes
- data AppflowIntegrationWorkflowMetrics = AppflowIntegrationWorkflowMetrics' Integer Integer Integer
- newAppflowIntegrationWorkflowMetrics :: Integer -> Integer -> Integer -> AppflowIntegrationWorkflowMetrics
- data AppflowIntegrationWorkflowStep = AppflowIntegrationWorkflowStep' Text Status Text Integer Text Text POSIX POSIX
- newAppflowIntegrationWorkflowStep :: Text -> Status -> Text -> Integer -> Text -> Text -> UTCTime -> UTCTime -> AppflowIntegrationWorkflowStep
- data AutoMerging = AutoMerging' (Maybe ConflictResolution) (Maybe Consolidation) (Maybe Double) Bool
- newAutoMerging :: Bool -> AutoMerging
- data Batch = Batch' POSIX POSIX
- newBatch :: UTCTime -> UTCTime -> Batch
- data ConflictResolution = ConflictResolution' (Maybe Text) ConflictResolvingModel
- newConflictResolution :: ConflictResolvingModel -> ConflictResolution
- data ConnectorOperator = ConnectorOperator' (Maybe MarketoConnectorOperator) (Maybe S3ConnectorOperator) (Maybe SalesforceConnectorOperator) (Maybe ServiceNowConnectorOperator) (Maybe ZendeskConnectorOperator)
- newConnectorOperator :: ConnectorOperator
- data Consolidation = Consolidation' (NonEmpty (NonEmpty Text))
- newConsolidation :: NonEmpty (NonEmpty Text) -> Consolidation
- data DomainStats = DomainStats' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newDomainStats :: DomainStats
- data ExportingConfig = ExportingConfig' (Maybe S3ExportingConfig)
- newExportingConfig :: ExportingConfig
- data ExportingLocation = ExportingLocation' (Maybe S3ExportingLocation)
- newExportingLocation :: ExportingLocation
- data FieldSourceProfileIds = FieldSourceProfileIds' (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) (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 FoundByKeyValue = FoundByKeyValue' (Maybe Text) (Maybe [Text])
- newFoundByKeyValue :: FoundByKeyValue
- data IdentityResolutionJob = IdentityResolutionJob' (Maybe Text) (Maybe ExportingLocation) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe JobStats) (Maybe Text) (Maybe IdentityResolutionJobStatus)
- newIdentityResolutionJob :: IdentityResolutionJob
- data IncrementalPullConfig = IncrementalPullConfig' (Maybe Text)
- newIncrementalPullConfig :: IncrementalPullConfig
- data IntegrationConfig = IntegrationConfig' (Maybe AppflowIntegration)
- newIntegrationConfig :: IntegrationConfig
- data JobSchedule = JobSchedule' JobScheduleDayOfTheWeek Text
- newJobSchedule :: JobScheduleDayOfTheWeek -> Text -> JobSchedule
- data JobStats = JobStats' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newJobStats :: JobStats
- data ListDomainItem = ListDomainItem' (Maybe (HashMap Text Text)) Text POSIX POSIX
- newListDomainItem :: Text -> UTCTime -> UTCTime -> ListDomainItem
- data ListIntegrationItem = ListIntegrationItem' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text POSIX POSIX
- newListIntegrationItem :: 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 ListWorkflowsItem = ListWorkflowsItem' WorkflowType Text Status Text POSIX POSIX
- newListWorkflowsItem :: WorkflowType -> Text -> Status -> Text -> UTCTime -> UTCTime -> ListWorkflowsItem
- data MarketoSourceProperties = MarketoSourceProperties' Text
- newMarketoSourceProperties :: Text -> MarketoSourceProperties
- data MatchItem = MatchItem' (Maybe Double) (Maybe Text) (Maybe [Text])
- newMatchItem :: MatchItem
- data MatchingRequest = MatchingRequest' (Maybe AutoMerging) (Maybe ExportingConfig) (Maybe JobSchedule) Bool
- newMatchingRequest :: Bool -> MatchingRequest
- data MatchingResponse = MatchingResponse' (Maybe AutoMerging) (Maybe Bool) (Maybe ExportingConfig) (Maybe JobSchedule)
- newMatchingResponse :: MatchingResponse
- data ObjectFilter = ObjectFilter' Text [Text]
- newObjectFilter :: Text -> ObjectFilter
- data ObjectTypeField = ObjectTypeField' (Maybe FieldContentType) (Maybe Text) (Maybe Text)
- newObjectTypeField :: ObjectTypeField
- data ObjectTypeKey = ObjectTypeKey' (Maybe [Text]) (Maybe [StandardIdentifier])
- newObjectTypeKey :: ObjectTypeKey
- data Profile = Profile' (Maybe Text) (Maybe Text) (Maybe Address) (Maybe (HashMap Text Text)) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty FoundByKeyValue)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address)
- newProfile :: Profile
- data S3ExportingConfig = S3ExportingConfig' (Maybe Text) Text
- newS3ExportingConfig :: Text -> S3ExportingConfig
- data S3ExportingLocation = S3ExportingLocation' (Maybe Text) (Maybe Text)
- newS3ExportingLocation :: S3ExportingLocation
- data S3SourceProperties = S3SourceProperties' (Maybe Text) Text
- newS3SourceProperties :: Text -> S3SourceProperties
- data SalesforceSourceProperties = SalesforceSourceProperties' (Maybe Bool) (Maybe Bool) Text
- newSalesforceSourceProperties :: Text -> SalesforceSourceProperties
- data ScheduledTriggerProperties = ScheduledTriggerProperties' (Maybe DataPullMode) (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) Text
- newScheduledTriggerProperties :: Text -> ScheduledTriggerProperties
- data ServiceNowSourceProperties = ServiceNowSourceProperties' Text
- newServiceNowSourceProperties :: Text -> ServiceNowSourceProperties
- data SourceConnectorProperties = SourceConnectorProperties' (Maybe MarketoSourceProperties) (Maybe S3SourceProperties) (Maybe SalesforceSourceProperties) (Maybe ServiceNowSourceProperties) (Maybe ZendeskSourceProperties)
- newSourceConnectorProperties :: SourceConnectorProperties
- data SourceFlowConfig = SourceFlowConfig' (Maybe Text) (Maybe IncrementalPullConfig) SourceConnectorType SourceConnectorProperties
- newSourceFlowConfig :: SourceConnectorType -> SourceConnectorProperties -> SourceFlowConfig
- data Task = Task' (Maybe ConnectorOperator) (Maybe Text) (Maybe (HashMap OperatorPropertiesKeys 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 WorkflowAttributes = WorkflowAttributes' (Maybe AppflowIntegrationWorkflowAttributes)
- newWorkflowAttributes :: WorkflowAttributes
- data WorkflowMetrics = WorkflowMetrics' (Maybe AppflowIntegrationWorkflowMetrics)
- newWorkflowMetrics :: WorkflowMetrics
- data WorkflowStepItem = WorkflowStepItem' (Maybe AppflowIntegrationWorkflowStep)
- newWorkflowStepItem :: WorkflowStepItem
- 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 => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input you provided is invalid.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal service error occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist, or access was denied.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
You exceeded the maximum number of requests.
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.
AddProfileKey
data AddProfileKey Source #
See: newAddProfileKey
smart constructor.
Instances
Create a value of AddProfileKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddProfileKey
, addProfileKey_profileId
- The unique identifier of a customer profile.
AddProfileKey
, addProfileKey_keyName
- A searchable identifier of a customer profile. The predefined keys you
can use include: _account, _profileId, _assetId, _caseId, _orderId,
_fullName, _phone, _email, _ctrContactId, _marketoLeadId,
_salesforceAccountId, _salesforceContactId, _salesforceAssetId,
_zendeskUserId, _zendeskExternalId, _zendeskTicketId,
_serviceNowSystemId, _serviceNowIncidentId, _segmentUserId,
_shopifyCustomerId, _shopifyOrderId.
AddProfileKey
, addProfileKey_values
- A list of key values.
AddProfileKey
, addProfileKey_domainName
- The unique name of the domain.
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:
AddProfileKey
, addProfileKeyResponse_keyName
- A searchable identifier of a customer profile.
AddProfileKey
, addProfileKeyResponse_values
- A list of key values.
$sel:httpStatus:AddProfileKeyResponse'
, addProfileKeyResponse_httpStatus
- The response's http status code.
CreateDomain
data CreateDomain Source #
See: newCreateDomain
smart constructor.
CreateDomain' (Maybe Text) (Maybe Text) (Maybe MatchingRequest) (Maybe (HashMap Text Text)) Text Natural |
Instances
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:
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.
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.
CreateDomain
, createDomain_matching
- The process of matching duplicate profiles. If Matching
= true
,
Amazon Connect Customer Profiles starts a weekly batch process called
Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at
12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
GetMatches
API to return and review the results. Or, if you have configured
ExportingConfig
in the MatchingRequest
, you can download the results
from S3.
CreateDomain
, createDomain_tags
- The tags used to organize, track, or control access for this resource.
CreateDomain
, createDomain_domainName
- The unique name of the domain.
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 Text) (Maybe MatchingResponse) (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:
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.
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.
CreateDomain
, createDomainResponse_matching
- The process of matching duplicate profiles. If Matching
= true
,
Amazon Connect Customer Profiles starts a weekly batch process called
Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at
12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
GetMatches
API to return and review the results. Or, if you have configured
ExportingConfig
in the MatchingRequest
, you can download the results
from S3.
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.
CreateDomain
, createDomainResponse_domainName
- The unique name of the domain.
CreateDomain
, createDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
CreateDomainResponse
, createDomainResponse_createdAt
- The timestamp of when the domain was created.
CreateDomainResponse
, createDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
CreateIntegrationWorkflow
data CreateIntegrationWorkflow Source #
See: newCreateIntegrationWorkflow
smart constructor.
CreateIntegrationWorkflow' (Maybe (HashMap Text Text)) Text WorkflowType IntegrationConfig Text Text |
Instances
newCreateIntegrationWorkflow Source #
:: Text | |
-> WorkflowType | |
-> IntegrationConfig | |
-> Text | |
-> Text | |
-> CreateIntegrationWorkflow |
Create a value of CreateIntegrationWorkflow
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:
CreateIntegrationWorkflow
, createIntegrationWorkflow_tags
- The tags used to organize, track, or control access for this resource.
CreateIntegrationWorkflow
, createIntegrationWorkflow_domainName
- The unique name of the domain.
CreateIntegrationWorkflow
, createIntegrationWorkflow_workflowType
- The type of workflow. The only supported value is APPFLOW_INTEGRATION.
$sel:integrationConfig:CreateIntegrationWorkflow'
, createIntegrationWorkflow_integrationConfig
- Configuration data for integration workflow.
CreateIntegrationWorkflow
, createIntegrationWorkflow_objectTypeName
- The name of the profile object type.
CreateIntegrationWorkflow
, createIntegrationWorkflow_roleArn
- The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
assumes this role to create resources on your behalf as part of workflow
execution.
data CreateIntegrationWorkflowResponse Source #
See: newCreateIntegrationWorkflowResponse
smart constructor.
Instances
newCreateIntegrationWorkflowResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateIntegrationWorkflowResponse |
Create a value of CreateIntegrationWorkflowResponse
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:CreateIntegrationWorkflowResponse'
, createIntegrationWorkflowResponse_httpStatus
- The response's http status code.
CreateIntegrationWorkflowResponse
, createIntegrationWorkflowResponse_workflowId
- Unique identifier for the workflow.
CreateIntegrationWorkflowResponse
, createIntegrationWorkflowResponse_message
- A message indicating create request was received.
CreateProfile
data CreateProfile Source #
See: newCreateProfile
smart constructor.
CreateProfile' (Maybe Text) (Maybe Text) (Maybe Address) (Maybe (HashMap Text Text)) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) 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:
CreateProfile
, createProfile_accountNumber
- A unique account number that you have given to the customer.
CreateProfile
, createProfile_additionalInformation
- Any additional information relevant to the customer’s profile.
CreateProfile
, createProfile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
CreateProfile
, createProfile_attributes
- A key value pair of attributes of a customer profile.
CreateProfile
, createProfile_billingAddress
- The customer’s billing address.
CreateProfile
, createProfile_birthDate
- The customer’s birth date.
CreateProfile
, createProfile_businessEmailAddress
- The customer’s business email address.
CreateProfile
, createProfile_businessName
- The name of the customer’s business.
CreateProfile
, createProfile_businessPhoneNumber
- The customer’s business phone number.
CreateProfile
, createProfile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
CreateProfile
, createProfile_firstName
- The customer’s first name.
CreateProfile
, createProfile_gender
- The gender with which the customer identifies.
$sel:genderString:CreateProfile'
, createProfile_genderString
- An alternative to Gender
which accepts any string as input.
CreateProfile
, createProfile_homePhoneNumber
- The customer’s home phone number.
CreateProfile
, createProfile_lastName
- The customer’s last name.
CreateProfile
, createProfile_mailingAddress
- The customer’s mailing address.
CreateProfile
, createProfile_middleName
- The customer’s middle name.
CreateProfile
, createProfile_mobilePhoneNumber
- The customer’s mobile phone number.
CreateProfile
, createProfile_partyType
- The type of profile used to describe the customer.
$sel:partyTypeString:CreateProfile'
, createProfile_partyTypeString
- An alternative to PartyType
which accepts any string as input.
CreateProfile
, createProfile_personalEmailAddress
- The customer’s personal email address.
CreateProfile
, createProfile_phoneNumber
- The customer’s phone number, which has not been specified as a mobile,
home, or business number.
CreateProfile
, createProfile_shippingAddress
- The customer’s shipping address.
CreateProfile
, createProfile_domainName
- The unique name of the domain.
data CreateProfileResponse Source #
See: newCreateProfileResponse
smart constructor.
Instances
newCreateProfileResponse Source #
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.
CreateProfileResponse
, createProfileResponse_profileId
- The unique identifier of a customer profile.
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:
DeleteDomain
, deleteDomain_domainName
- The unique name of the domain.
data DeleteDomainResponse Source #
See: newDeleteDomainResponse
smart constructor.
Instances
newDeleteDomainResponse Source #
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.
DeleteDomainResponse
, deleteDomainResponse_message
- A message that indicates the delete request is done.
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:
DeleteIntegration
, deleteIntegration_domainName
- The unique name of the domain.
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.
DeleteIntegrationResponse
, deleteIntegrationResponse_message
- A message that indicates the delete request is done.
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:
DeleteProfile
, deleteProfile_profileId
- The unique identifier of a customer profile.
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:
DeleteProfileResponse
, deleteProfileResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileResponse'
, deleteProfileResponse_httpStatus
- The response's http status code.
DeleteProfileKey
data DeleteProfileKey Source #
See: newDeleteProfileKey
smart constructor.
Instances
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:
DeleteProfileKey
, deleteProfileKey_profileId
- The unique identifier of a customer profile.
DeleteProfileKey
, deleteProfileKey_keyName
- A searchable identifier of a customer profile.
DeleteProfileKey
, deleteProfileKey_values
- A list of key values.
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:
DeleteProfileKeyResponse
, deleteProfileKeyResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileKeyResponse'
, deleteProfileKeyResponse_httpStatus
- The response's http status code.
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:
DeleteProfileObject
, deleteProfileObject_profileId
- The unique identifier of a customer profile.
DeleteProfileObject
, deleteProfileObject_profileObjectUniqueKey
- The unique identifier of the profile object generated by the service.
DeleteProfileObject
, deleteProfileObject_objectTypeName
- The name of the profile object type.
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:
DeleteProfileObjectResponse
, deleteProfileObjectResponse_message
- A message that indicates the delete request is done.
$sel:httpStatus:DeleteProfileObjectResponse'
, deleteProfileObjectResponse_httpStatus
- The response's http status code.
DeleteProfileObjectType
data DeleteProfileObjectType Source #
See: newDeleteProfileObjectType
smart constructor.
Instances
newDeleteProfileObjectType Source #
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:
DeleteProfileObjectType
, deleteProfileObjectType_domainName
- The unique name of the domain.
DeleteProfileObjectType
, deleteProfileObjectType_objectTypeName
- The name of the profile object type.
data DeleteProfileObjectTypeResponse Source #
See: newDeleteProfileObjectTypeResponse
smart constructor.
Instances
Generic DeleteProfileObjectTypeResponse Source # | |
Read DeleteProfileObjectTypeResponse Source # | |
Show DeleteProfileObjectTypeResponse Source # | |
NFData DeleteProfileObjectTypeResponse Source # | |
Defined in Amazonka.CustomerProfiles.DeleteProfileObjectType rnf :: DeleteProfileObjectTypeResponse -> () # | |
Eq DeleteProfileObjectTypeResponse Source # | |
type Rep DeleteProfileObjectTypeResponse Source # | |
Defined in Amazonka.CustomerProfiles.DeleteProfileObjectType type Rep DeleteProfileObjectTypeResponse = D1 ('MetaData "DeleteProfileObjectTypeResponse" "Amazonka.CustomerProfiles.DeleteProfileObjectType" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" '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.
DeleteProfileObjectTypeResponse
, deleteProfileObjectTypeResponse_message
- A message that indicates the delete request is done.
DeleteWorkflow
data DeleteWorkflow Source #
See: newDeleteWorkflow
smart constructor.
Instances
Create a value of DeleteWorkflow
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:
DeleteWorkflow
, deleteWorkflow_domainName
- The unique name of the domain.
DeleteWorkflow
, deleteWorkflow_workflowId
- Unique identifier for the workflow.
data DeleteWorkflowResponse Source #
See: newDeleteWorkflowResponse
smart constructor.
Instances
newDeleteWorkflowResponse Source #
Create a value of DeleteWorkflowResponse
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:DeleteWorkflowResponse'
, deleteWorkflowResponse_httpStatus
- The response's http status code.
GetAutoMergingPreview
data GetAutoMergingPreview Source #
See: newGetAutoMergingPreview
smart constructor.
Instances
newGetAutoMergingPreview Source #
Create a value of GetAutoMergingPreview
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:
GetAutoMergingPreview
, getAutoMergingPreview_minAllowedConfidenceScoreForMerging
- Minimum confidence score required for profiles within a matching group
to be merged during the auto-merge process.
GetAutoMergingPreview
, getAutoMergingPreview_domainName
- The unique name of the domain.
GetAutoMergingPreview
, getAutoMergingPreview_consolidation
- A list of matching attributes that represent matching criteria.
GetAutoMergingPreview
, getAutoMergingPreview_conflictResolution
- How the auto-merging process should resolve conflicts between different
profiles.
data GetAutoMergingPreviewResponse Source #
See: newGetAutoMergingPreviewResponse
smart constructor.
Instances
newGetAutoMergingPreviewResponse Source #
:: Int | |
-> Text | |
-> GetAutoMergingPreviewResponse |
Create a value of GetAutoMergingPreviewResponse
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:numberOfMatchesInSample:GetAutoMergingPreviewResponse'
, getAutoMergingPreviewResponse_numberOfMatchesInSample
- The number of match groups in the domain that have been reviewed in this
preview dry run.
$sel:numberOfProfilesInSample:GetAutoMergingPreviewResponse'
, getAutoMergingPreviewResponse_numberOfProfilesInSample
- The number of profiles found in this preview dry run.
$sel:numberOfProfilesWillBeMerged:GetAutoMergingPreviewResponse'
, getAutoMergingPreviewResponse_numberOfProfilesWillBeMerged
- The number of profiles that would be merged if this wasn't a preview
dry run.
$sel:httpStatus:GetAutoMergingPreviewResponse'
, getAutoMergingPreviewResponse_httpStatus
- The response's http status code.
GetAutoMergingPreview
, getAutoMergingPreviewResponse_domainName
- The unique name of the domain.
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:
GetDomain
, getDomain_domainName
- The unique name of the domain.
data GetDomainResponse Source #
See: newGetDomainResponse
smart constructor.
GetDomainResponse' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingResponse) (Maybe DomainStats) (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: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: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:defaultExpirationDays:GetDomainResponse'
, getDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:matching:GetDomainResponse'
, getDomainResponse_matching
- The process of matching duplicate profiles. If Matching
= true
,
Amazon Connect Customer Profiles starts a weekly batch process called
Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at
12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
GetMatches
API to return and review the results. Or, if you have configured
ExportingConfig
in the MatchingRequest
, you can download the results
from S3.
$sel:stats:GetDomainResponse'
, getDomainResponse_stats
- Usage-specific statistics about the domain.
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.
GetDomain
, getDomainResponse_domainName
- The unique name of the domain.
GetDomainResponse
, getDomainResponse_createdAt
- The timestamp of when the domain was created.
GetDomainResponse
, getDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
GetIdentityResolutionJob
data GetIdentityResolutionJob Source #
See: newGetIdentityResolutionJob
smart constructor.
Instances
newGetIdentityResolutionJob Source #
Create a value of GetIdentityResolutionJob
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:
GetIdentityResolutionJob
, getIdentityResolutionJob_domainName
- The unique name of the domain.
GetIdentityResolutionJob
, getIdentityResolutionJob_jobId
- The unique identifier of the Identity Resolution Job.
data GetIdentityResolutionJobResponse Source #
See: newGetIdentityResolutionJobResponse
smart constructor.
Instances
newGetIdentityResolutionJobResponse Source #
Create a value of GetIdentityResolutionJobResponse
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:
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_autoMerging
- Configuration settings for how to perform the auto-merging of profiles.
GetIdentityResolutionJob
, getIdentityResolutionJobResponse_domainName
- The unique name of the domain.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_exportingLocation
- The S3 location where the Identity Resolution Job writes result files.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobEndTime
- The timestamp of when the Identity Resolution Job was completed.
$sel:jobExpirationTime:GetIdentityResolutionJobResponse'
, getIdentityResolutionJobResponse_jobExpirationTime
- The timestamp of when the Identity Resolution Job will expire.
GetIdentityResolutionJob
, getIdentityResolutionJobResponse_jobId
- The unique identifier of the Identity Resolution Job.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobStartTime
- The timestamp of when the Identity Resolution Job was started or will be
started.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobStats
- Statistics about the Identity Resolution Job.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_lastUpdatedAt
- The timestamp of when the Identity Resolution Job was most recently
edited.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_message
- The error messages that are generated when the Identity Resolution Job
runs.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_status
- The status of the Identity Resolution Job.
PENDING
: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in thePENDING
state are deleted.PREPROCESSING
: The Identity Resolution Job is loading your data.FIND_MATCHING
: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.MERGING
: The Identity Resolution Job is merging duplicate profiles.COMPLETED
: The Identity Resolution Job completed successfully.PARTIAL_SUCCESS
: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.FAILED
: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
$sel:httpStatus:GetIdentityResolutionJobResponse'
, getIdentityResolutionJobResponse_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:
GetIntegration
, getIntegration_domainName
- The unique name of the domain.
GetIntegration
, getIntegration_uri
- The URI of the S3 bucket or any other type of data source.
data GetIntegrationResponse Source #
See: newGetIntegrationResponse
smart constructor.
GetIntegrationResponse' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text POSIX POSIX |
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:
GetIntegrationResponse
, getIntegrationResponse_isUnstructured
- Boolean to indicate if the Flow associated with the Integration is
created via Appflow console or with ObjectTypeName equals _unstructured
via API/CLI in flowDefinition
GetIntegrationResponse
, getIntegrationResponse_objectTypeName
- The name of the profile object type.
GetIntegrationResponse
, getIntegrationResponse_objectTypeNames
- A map in which each key is an event type from an external application
such as Segment or Shopify, and each value is an ObjectTypeName
(template) used to ingest the event. It supports the following event
types: SegmentIdentify
, ShopifyCreateCustomers
,
ShopifyUpdateCustomers
, ShopifyCreateDraftOrders
,
ShopifyUpdateDraftOrders
, ShopifyCreateOrders
, and
ShopifyUpdatedOrders
.
GetIntegrationResponse
, getIntegrationResponse_tags
- The tags used to organize, track, or control access for this resource.
GetIntegrationResponse
, getIntegrationResponse_workflowId
- Unique identifier for the workflow.
$sel:httpStatus:GetIntegrationResponse'
, getIntegrationResponse_httpStatus
- The response's http status code.
GetIntegration
, getIntegrationResponse_domainName
- The unique name of the domain.
GetIntegration
, getIntegrationResponse_uri
- The URI of the S3 bucket or any other type of data source.
GetIntegrationResponse
, getIntegrationResponse_createdAt
- The timestamp of when the domain was created.
GetIntegrationResponse
, getIntegrationResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
GetMatches
data GetMatches Source #
See: newGetMatches
smart constructor.
Instances
:: Text | |
-> GetMatches |
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:maxResults:GetMatches'
, getMatches_maxResults
- The maximum number of results to return per page.
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.
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:matchGenerationDate:GetMatchesResponse'
, getMatchesResponse_matchGenerationDate
- The timestamp this version of Match Result generated.
$sel:matches:GetMatchesResponse'
, getMatchesResponse_matches
- The list of matched profiles for this instance.
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.
GetProfileObjectType
data GetProfileObjectType Source #
See: newGetProfileObjectType
smart constructor.
Instances
newGetProfileObjectType Source #
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:
GetProfileObjectType
, getProfileObjectType_domainName
- The unique name of the domain.
GetProfileObjectType
, getProfileObjectType_objectTypeName
- The name of the profile object type.
data GetProfileObjectTypeResponse Source #
See: newGetProfileObjectTypeResponse
smart constructor.
GetProfileObjectTypeResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe 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: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.
GetProfileObjectTypeResponse
, getProfileObjectTypeResponse_createdAt
- The timestamp of when the domain was created.
$sel:encryptionKey:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
$sel:expirationDays:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_expirationDays
- The number of days until the data in the object expires.
$sel:fields:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_fields
- A map of the name and ObjectType field.
$sel:keys:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_keys
- A list of unique keys that can be used to map data to the profile.
GetProfileObjectTypeResponse
, getProfileObjectTypeResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
$sel:sourceLastUpdatedTimestampFormat:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up.
GetProfileObjectTypeResponse
, getProfileObjectTypeResponse_tags
- The tags used to organize, track, or control access for this resource.
GetProfileObjectTypeResponse
, getProfileObjectTypeResponse_templateId
- A unique identifier for the object template.
$sel:httpStatus:GetProfileObjectTypeResponse'
, getProfileObjectTypeResponse_httpStatus
- The response's http status code.
GetProfileObjectType
, getProfileObjectTypeResponse_objectTypeName
- The name of the profile object type.
GetProfileObjectTypeResponse
, getProfileObjectTypeResponse_description
- The description of the profile object type.
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:
GetProfileObjectTypeTemplate
, getProfileObjectTypeTemplate_templateId
- A unique identifier for the object template.
data GetProfileObjectTypeTemplateResponse Source #
See: newGetProfileObjectTypeTemplateResponse
smart constructor.
GetProfileObjectTypeTemplateResponse' (Maybe Bool) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) 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: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:keys:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_keys
- A list of unique keys that can be used to map data to the profile.
$sel:sourceLastUpdatedTimestampFormat:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up.
GetProfileObjectTypeTemplateResponse
, getProfileObjectTypeTemplateResponse_sourceName
- The name of the source of the object template.
GetProfileObjectTypeTemplateResponse
, getProfileObjectTypeTemplateResponse_sourceObject
- The source of the object template.
GetProfileObjectTypeTemplate
, getProfileObjectTypeTemplateResponse_templateId
- A unique identifier for the object template.
$sel:httpStatus:GetProfileObjectTypeTemplateResponse'
, getProfileObjectTypeTemplateResponse_httpStatus
- The response's http status code.
GetWorkflow
data GetWorkflow Source #
See: newGetWorkflow
smart constructor.
Instances
Create a value of GetWorkflow
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:
GetWorkflow
, getWorkflow_domainName
- The unique name of the domain.
GetWorkflow
, getWorkflow_workflowId
- Unique identifier for the workflow.
data GetWorkflowResponse Source #
See: newGetWorkflowResponse
smart constructor.
GetWorkflowResponse' (Maybe WorkflowAttributes) (Maybe Text) (Maybe POSIX) (Maybe WorkflowMetrics) (Maybe POSIX) (Maybe Status) (Maybe Text) (Maybe WorkflowType) Int |
Instances
newGetWorkflowResponse Source #
Create a value of GetWorkflowResponse
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:
GetWorkflowResponse
, getWorkflowResponse_attributes
- Attributes provided for workflow execution.
$sel:errorDescription:GetWorkflowResponse'
, getWorkflowResponse_errorDescription
- Workflow error messages during execution (if any).
GetWorkflowResponse
, getWorkflowResponse_lastUpdatedAt
- The timestamp that represents when workflow execution last updated.
$sel:metrics:GetWorkflowResponse'
, getWorkflowResponse_metrics
- Workflow specific execution metrics.
$sel:startDate:GetWorkflowResponse'
, getWorkflowResponse_startDate
- The timestamp that represents when workflow execution started.
GetWorkflowResponse
, getWorkflowResponse_status
- Status of workflow execution.
GetWorkflow
, getWorkflowResponse_workflowId
- Unique identifier for the workflow.
GetWorkflowResponse
, getWorkflowResponse_workflowType
- The type of workflow. The only supported value is APPFLOW_INTEGRATION.
$sel:httpStatus:GetWorkflowResponse'
, getWorkflowResponse_httpStatus
- The response's http status code.
GetWorkflowSteps
data GetWorkflowSteps Source #
See: newGetWorkflowSteps
smart constructor.
Instances
Create a value of GetWorkflowSteps
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:maxResults:GetWorkflowSteps'
, getWorkflowSteps_maxResults
- The maximum number of results to return per page.
GetWorkflowSteps
, getWorkflowSteps_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.
GetWorkflowSteps
, getWorkflowSteps_domainName
- The unique name of the domain.
GetWorkflowSteps
, getWorkflowSteps_workflowId
- Unique identifier for the workflow.
data GetWorkflowStepsResponse Source #
See: newGetWorkflowStepsResponse
smart constructor.
GetWorkflowStepsResponse' (Maybe [WorkflowStepItem]) (Maybe Text) (Maybe Text) (Maybe WorkflowType) Int |
Instances
newGetWorkflowStepsResponse Source #
Create a value of GetWorkflowStepsResponse
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:GetWorkflowStepsResponse'
, getWorkflowStepsResponse_items
- List containing workflow step details.
GetWorkflowSteps
, getWorkflowStepsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
GetWorkflowSteps
, getWorkflowStepsResponse_workflowId
- Unique identifier for the workflow.
GetWorkflowStepsResponse
, getWorkflowStepsResponse_workflowType
- The type of workflow. The only supported value is APPFLOW_INTEGRATION.
$sel:httpStatus:GetWorkflowStepsResponse'
, getWorkflowStepsResponse_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:includeHidden:ListAccountIntegrations'
, listAccountIntegrations_includeHidden
- Boolean to indicate if hidden integration should be returned. Defaults
to False
.
$sel:maxResults:ListAccountIntegrations'
, listAccountIntegrations_maxResults
- The maximum number of objects returned per page.
ListAccountIntegrations
, listAccountIntegrations_nextToken
- The pagination token from the previous ListAccountIntegrations API call.
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.
ListAccountIntegrations
, listAccountIntegrationsResponse_nextToken
- The pagination token from the previous ListAccountIntegrations API call.
$sel:httpStatus:ListAccountIntegrationsResponse'
, listAccountIntegrationsResponse_httpStatus
- The response's http status code.
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:maxResults:ListDomains'
, listDomains_maxResults
- The maximum number of objects returned per page.
ListDomains
, listDomains_nextToken
- The pagination token from the previous ListDomain API call.
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.
ListDomains
, listDomainsResponse_nextToken
- The pagination token from the previous ListDomains API call.
$sel:httpStatus:ListDomainsResponse'
, listDomainsResponse_httpStatus
- The response's http status code.
ListIdentityResolutionJobs
data ListIdentityResolutionJobs Source #
See: newListIdentityResolutionJobs
smart constructor.
Instances
newListIdentityResolutionJobs Source #
Create a value of ListIdentityResolutionJobs
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:maxResults:ListIdentityResolutionJobs'
, listIdentityResolutionJobs_maxResults
- The maximum number of results to return per page.
ListIdentityResolutionJobs
, listIdentityResolutionJobs_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.
ListIdentityResolutionJobs
, listIdentityResolutionJobs_domainName
- The unique name of the domain.
data ListIdentityResolutionJobsResponse Source #
See: newListIdentityResolutionJobsResponse
smart constructor.
Instances
newListIdentityResolutionJobsResponse Source #
Create a value of ListIdentityResolutionJobsResponse
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:identityResolutionJobsList:ListIdentityResolutionJobsResponse'
, listIdentityResolutionJobsResponse_identityResolutionJobsList
- A list of Identity Resolution Jobs.
ListIdentityResolutionJobs
, listIdentityResolutionJobsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListIdentityResolutionJobsResponse'
, listIdentityResolutionJobsResponse_httpStatus
- The response's http status code.
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:includeHidden:ListIntegrations'
, listIntegrations_includeHidden
- Boolean to indicate if hidden integration should be returned. Defaults
to False
.
$sel:maxResults:ListIntegrations'
, listIntegrations_maxResults
- The maximum number of objects returned per page.
ListIntegrations
, listIntegrations_nextToken
- The pagination token from the previous ListIntegrations API call.
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.
ListIntegrations
, listIntegrationsResponse_nextToken
- The pagination token from the previous ListIntegrations API call.
$sel:httpStatus:ListIntegrationsResponse'
, listIntegrationsResponse_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:maxResults:ListProfileObjectTypeTemplates'
, listProfileObjectTypeTemplates_maxResults
- The maximum number of objects returned per page.
ListProfileObjectTypeTemplates
, listProfileObjectTypeTemplates_nextToken
- The pagination token from the previous ListObjectTypeTemplates API call.
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.
ListProfileObjectTypeTemplates
, listProfileObjectTypeTemplatesResponse_nextToken
- The pagination token from the previous ListObjectTypeTemplates API call.
$sel:httpStatus:ListProfileObjectTypeTemplatesResponse'
, listProfileObjectTypeTemplatesResponse_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:maxResults:ListProfileObjectTypes'
, listProfileObjectTypes_maxResults
- The maximum number of objects returned per page.
ListProfileObjectTypes
, listProfileObjectTypes_nextToken
- Identifies the next page of results to return.
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.
ListProfileObjectTypes
, listProfileObjectTypesResponse_nextToken
- Identifies the next page of results to return.
$sel:httpStatus:ListProfileObjectTypesResponse'
, listProfileObjectTypesResponse_httpStatus
- The response's http status code.
ListProfileObjects
data ListProfileObjects Source #
See: newListProfileObjects
smart constructor.
Instances
newListProfileObjects Source #
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:maxResults:ListProfileObjects'
, listProfileObjects_maxResults
- The maximum number of objects returned per page.
ListProfileObjects
, listProfileObjects_nextToken
- The pagination token from the previous call to ListProfileObjects.
$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, _case and _order.
ListProfileObjects
, listProfileObjects_domainName
- The unique name of the domain.
ListProfileObjects
, listProfileObjects_objectTypeName
- The name of the profile object type.
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.
ListProfileObjects
, listProfileObjectsResponse_nextToken
- The pagination token from the previous call to ListProfileObjects.
$sel:httpStatus:ListProfileObjectsResponse'
, listProfileObjectsResponse_httpStatus
- The response's http status code.
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:
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.
ListWorkflows
data ListWorkflows Source #
See: newListWorkflows
smart constructor.
ListWorkflows' (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Status) (Maybe WorkflowType) Text |
Instances
Create a value of ListWorkflows
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:maxResults:ListWorkflows'
, listWorkflows_maxResults
- The maximum number of results to return per page.
ListWorkflows
, listWorkflows_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:queryEndDate:ListWorkflows'
, listWorkflows_queryEndDate
- Retrieve workflows ended after timestamp.
$sel:queryStartDate:ListWorkflows'
, listWorkflows_queryStartDate
- Retrieve workflows started after timestamp.
ListWorkflows
, listWorkflows_status
- Status of workflow execution.
ListWorkflows
, listWorkflows_workflowType
- The type of workflow. The only supported value is APPFLOW_INTEGRATION.
ListWorkflows
, listWorkflows_domainName
- The unique name of the domain.
data ListWorkflowsResponse Source #
See: newListWorkflowsResponse
smart constructor.
Instances
newListWorkflowsResponse Source #
Create a value of ListWorkflowsResponse
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:ListWorkflowsResponse'
, listWorkflowsResponse_items
- List containing workflow details.
ListWorkflows
, listWorkflowsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListWorkflowsResponse'
, listWorkflowsResponse_httpStatus
- The response's http status code.
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.
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:
MergeProfilesResponse
, mergeProfilesResponse_message
- A message that indicates the merge request is complete.
$sel:httpStatus:MergeProfilesResponse'
, mergeProfilesResponse_httpStatus
- The response's http status code.
PutIntegration
data PutIntegration Source #
See: newPutIntegration
smart constructor.
PutIntegration' (Maybe FlowDefinition) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text |
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:
PutIntegration
, putIntegration_flowDefinition
- The configuration that controls how Customer Profiles retrieves data
from the source.
PutIntegration
, putIntegration_objectTypeName
- The name of the profile object type.
PutIntegration
, putIntegration_objectTypeNames
- A map in which each key is an event type from an external application
such as Segment or Shopify, and each value is an ObjectTypeName
(template) used to ingest the event. It supports the following event
types: SegmentIdentify
, ShopifyCreateCustomers
,
ShopifyUpdateCustomers
, ShopifyCreateDraftOrders
,
ShopifyUpdateDraftOrders
, ShopifyCreateOrders
, and
ShopifyUpdatedOrders
.
PutIntegration
, putIntegration_tags
- The tags used to organize, track, or control access for this resource.
PutIntegration
, putIntegration_uri
- The URI of the S3 bucket or any other type of data source.
PutIntegration
, putIntegration_domainName
- The unique name of the domain.
data PutIntegrationResponse Source #
See: newPutIntegrationResponse
smart constructor.
PutIntegrationResponse' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int Text Text POSIX POSIX |
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:
PutIntegrationResponse
, putIntegrationResponse_isUnstructured
- Boolean to indicate if the Flow associated with the Integration is
created via Appflow console or with ObjectTypeName equals _unstructured
via API/CLI in flowDefinition
PutIntegration
, putIntegrationResponse_objectTypeName
- The name of the profile object type.
PutIntegration
, putIntegrationResponse_objectTypeNames
- A map in which each key is an event type from an external application
such as Segment or Shopify, and each value is an ObjectTypeName
(template) used to ingest the event. It supports the following event
types: SegmentIdentify
, ShopifyCreateCustomers
,
ShopifyUpdateCustomers
, ShopifyCreateDraftOrders
,
ShopifyUpdateDraftOrders
, ShopifyCreateOrders
, and
ShopifyUpdatedOrders
.
PutIntegration
, putIntegrationResponse_tags
- The tags used to organize, track, or control access for this resource.
PutIntegrationResponse
, putIntegrationResponse_workflowId
- Unique identifier for the workflow.
$sel:httpStatus:PutIntegrationResponse'
, putIntegrationResponse_httpStatus
- The response's http status code.
PutIntegration
, putIntegrationResponse_domainName
- The unique name of the domain.
PutIntegration
, putIntegrationResponse_uri
- The URI of the S3 bucket or any other type of data source.
PutIntegrationResponse
, putIntegrationResponse_createdAt
- The timestamp of when the domain was created.
PutIntegrationResponse
, putIntegrationResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
PutProfileObject
data PutProfileObject Source #
See: newPutProfileObject
smart constructor.
Instances
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:
PutProfileObject
, putProfileObject_objectTypeName
- The name of the profile object type.
PutProfileObject
, putProfileObject_object
- A string that is serialized from a JSON object.
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:
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.
PutProfileObjectType
data PutProfileObjectType Source #
See: newPutProfileObjectType
smart constructor.
PutProfileObjectType' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe 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:
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.
PutProfileObjectType
, putProfileObjectType_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
PutProfileObjectType
, putProfileObjectType_expirationDays
- The number of days until the data in the object expires.
PutProfileObjectType
, putProfileObjectType_fields
- A map of the name and ObjectType field.
PutProfileObjectType
, putProfileObjectType_keys
- A list of unique keys that can be used to map data to the profile.
PutProfileObjectType
, putProfileObjectType_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up.
PutProfileObjectType
, putProfileObjectType_tags
- The tags used to organize, track, or control access for this resource.
PutProfileObjectType
, putProfileObjectType_templateId
- A unique identifier for the object template. For some attributes in the
request, the service will use the default value from the object template
when TemplateId is present. If these attributes are present in the
request, the service may return a BadRequestException
. These
attributes include: AllowProfileCreation,
SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
AllowProfileCreation is set to true when TemplateId is set, the service
may return a BadRequestException
.
PutProfileObjectType
, putProfileObjectType_domainName
- The unique name of the domain.
PutProfileObjectType
, putProfileObjectType_objectTypeName
- The name of the profile object type.
PutProfileObjectType
, putProfileObjectType_description
- Description of the profile object type.
data PutProfileObjectTypeResponse Source #
See: newPutProfileObjectTypeResponse
smart constructor.
PutProfileObjectTypeResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe (HashMap Text ObjectTypeField)) (Maybe (HashMap Text [ObjectTypeKey])) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe 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:
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.
PutProfileObjectTypeResponse
, putProfileObjectTypeResponse_createdAt
- The timestamp of when the domain was created.
PutProfileObjectType
, putProfileObjectTypeResponse_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
PutProfileObjectType
, putProfileObjectTypeResponse_expirationDays
- The number of days until the data in the object expires.
PutProfileObjectType
, putProfileObjectTypeResponse_fields
- A map of the name and ObjectType field.
PutProfileObjectType
, putProfileObjectTypeResponse_keys
- A list of unique keys that can be used to map data to the profile.
PutProfileObjectTypeResponse
, putProfileObjectTypeResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
PutProfileObjectType
, putProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up in fields that were parsed using
SimpleDateFormat.
If you have sourceLastUpdatedTimestamp
in your field, you must set up
sourceLastUpdatedTimestampFormat
.
PutProfileObjectType
, putProfileObjectTypeResponse_tags
- The tags used to organize, track, or control access for this resource.
PutProfileObjectType
, putProfileObjectTypeResponse_templateId
- A unique identifier for the object template.
$sel:httpStatus:PutProfileObjectTypeResponse'
, putProfileObjectTypeResponse_httpStatus
- The response's http status code.
PutProfileObjectType
, putProfileObjectTypeResponse_objectTypeName
- The name of the profile object type.
PutProfileObjectType
, putProfileObjectTypeResponse_description
- Description of the profile object type.
SearchProfiles
data SearchProfiles Source #
See: newSearchProfiles
smart constructor.
SearchProfiles' (Maybe (NonEmpty AdditionalSearchKey)) (Maybe LogicalOperator) (Maybe Natural) (Maybe Text) Text Text [Text] |
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:additionalSearchKeys:SearchProfiles'
, searchProfiles_additionalSearchKeys
- A list of AdditionalSearchKey
objects that are each searchable
identifiers of a profile. Each AdditionalSearchKey
object contains a
KeyName
and a list of Values
associated with that specific key
(i.e., a key-value(s) pair). These additional search keys will be used
in conjunction with the LogicalOperator
and the required KeyName
and
Values
parameters to search for profiles that satisfy the search
criteria.
$sel:logicalOperator:SearchProfiles'
, searchProfiles_logicalOperator
- Relationship between all specified search keys that will be used to
search for profiles. This includes the required KeyName
and Values
parameters as well as any key-value(s) pairs specified in the
AdditionalSearchKeys
list.
This parameter influences which profiles will be returned in the response in the following manner:
AND
- The response only includes profiles that match all of the search keys.OR
- The response includes profiles that match at least one of the search keys.
The OR
relationship is the default behavior if this parameter is not
included in the request.
$sel:maxResults:SearchProfiles'
, searchProfiles_maxResults
- The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
SearchProfiles
, searchProfiles_nextToken
- The pagination token from the previous SearchProfiles API call.
SearchProfiles
, searchProfiles_domainName
- The unique name of the domain.
SearchProfiles
, searchProfiles_keyName
- A searchable identifier of a customer profile. The predefined keys you
can use to search include: _account, _profileId, _assetId, _caseId,
_orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
_salesforceAccountId, _salesforceContactId, _salesforceAssetId,
_zendeskUserId, _zendeskExternalId, _zendeskTicketId,
_serviceNowSystemId, _serviceNowIncidentId, _segmentUserId,
_shopifyCustomerId, _shopifyOrderId.
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 Profiles matching the search criteria.
SearchProfiles
, searchProfilesResponse_nextToken
- The pagination token from the previous SearchProfiles API call.
$sel:httpStatus:SearchProfilesResponse'
, searchProfilesResponse_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.
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.
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.
UpdateDomain
data UpdateDomain Source #
See: newUpdateDomain
smart constructor.
UpdateDomain' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingRequest) (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:
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.
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.
UpdateDomain
, updateDomain_defaultExpirationDays
- The default number of days until the data within the domain expires.
UpdateDomain
, updateDomain_matching
- The process of matching duplicate profiles. If Matching
= true
,
Amazon Connect Customer Profiles starts a weekly batch process called
Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at
12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
GetMatches
API to return and review the results. Or, if you have configured
ExportingConfig
in the MatchingRequest
, you can download the results
from S3.
UpdateDomain
, updateDomain_tags
- The tags used to organize, track, or control access for this resource.
UpdateDomain
, updateDomain_domainName
- The unique name of the domain.
data UpdateDomainResponse Source #
See: newUpdateDomainResponse
smart constructor.
UpdateDomainResponse' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe MatchingResponse) (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:
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.
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.
UpdateDomain
, updateDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
UpdateDomain
, updateDomainResponse_matching
- The process of matching duplicate profiles. If Matching
= true
,
Amazon Connect Customer Profiles starts a weekly batch process called
Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at
12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the
GetMatches
API to return and review the results. Or, if you have configured
ExportingConfig
in the MatchingRequest
, you can download the results
from S3.
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.
UpdateDomain
, updateDomainResponse_domainName
- The unique name of the domain.
UpdateDomainResponse
, updateDomainResponse_createdAt
- The timestamp of when the domain was created.
UpdateDomainResponse
, updateDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
UpdateProfile
data UpdateProfile Source #
See: newUpdateProfile
smart constructor.
UpdateProfile' (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe (HashMap Text Text)) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UpdateAddress) 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:
UpdateProfile
, updateProfile_accountNumber
- A unique account number that you have given to the customer.
UpdateProfile
, updateProfile_additionalInformation
- Any additional information relevant to the customer’s profile.
UpdateProfile
, updateProfile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
UpdateProfile
, updateProfile_attributes
- A key value pair of attributes of a customer profile.
UpdateProfile
, updateProfile_billingAddress
- The customer’s billing address.
UpdateProfile
, updateProfile_birthDate
- The customer’s birth date.
UpdateProfile
, updateProfile_businessEmailAddress
- The customer’s business email address.
UpdateProfile
, updateProfile_businessName
- The name of the customer’s business.
UpdateProfile
, updateProfile_businessPhoneNumber
- The customer’s business phone number.
UpdateProfile
, updateProfile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
UpdateProfile
, updateProfile_firstName
- The customer’s first name.
UpdateProfile
, updateProfile_gender
- The gender with which the customer identifies.
$sel:genderString:UpdateProfile'
, updateProfile_genderString
- An alternative to Gender
which accepts any string as input.
UpdateProfile
, updateProfile_homePhoneNumber
- The customer’s home phone number.
UpdateProfile
, updateProfile_lastName
- The customer’s last name.
UpdateProfile
, updateProfile_mailingAddress
- The customer’s mailing address.
UpdateProfile
, updateProfile_middleName
- The customer’s middle name.
UpdateProfile
, updateProfile_mobilePhoneNumber
- The customer’s mobile phone number.
UpdateProfile
, updateProfile_partyType
- The type of profile used to describe the customer.
$sel:partyTypeString:UpdateProfile'
, updateProfile_partyTypeString
- An alternative to PartyType
which accepts any string as input.
UpdateProfile
, updateProfile_personalEmailAddress
- The customer’s personal email address.
UpdateProfile
, updateProfile_phoneNumber
- The customer’s phone number, which has not been specified as a mobile,
home, or business number.
UpdateProfile
, updateProfile_shippingAddress
- The customer’s shipping address.
UpdateProfile
, updateProfile_domainName
- The unique name of the domain.
UpdateProfile
, updateProfile_profileId
- The unique identifier of a customer profile.
data UpdateProfileResponse Source #
See: newUpdateProfileResponse
smart constructor.
Instances
newUpdateProfileResponse Source #
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.
UpdateProfile
, updateProfileResponse_profileId
- The unique identifier of a customer profile.
Types
ConflictResolvingModel
newtype ConflictResolvingModel Source #
pattern ConflictResolvingModel_RECENCY :: ConflictResolvingModel | |
pattern ConflictResolvingModel_SOURCE :: ConflictResolvingModel |
Instances
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
IdentityResolutionJobStatus
newtype IdentityResolutionJobStatus Source #
Instances
JobScheduleDayOfTheWeek
newtype JobScheduleDayOfTheWeek Source #
Instances
LogicalOperator
newtype LogicalOperator Source #
pattern LogicalOperator_AND :: LogicalOperator | |
pattern LogicalOperator_OR :: LogicalOperator |
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_ORDER :: StandardIdentifier | |
pattern StandardIdentifier_PROFILE :: StandardIdentifier | |
pattern StandardIdentifier_SECONDARY :: StandardIdentifier | |
pattern StandardIdentifier_UNIQUE :: StandardIdentifier |
Instances
Status
pattern Status_CANCELLED :: Status | |
pattern Status_COMPLETE :: Status | |
pattern Status_FAILED :: Status | |
pattern Status_IN_PROGRESS :: Status | |
pattern Status_NOT_STARTED :: Status | |
pattern Status_RETRY :: Status | |
pattern Status_SPLIT :: Status |
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
WorkflowType
newtype WorkflowType Source #
pattern WorkflowType_APPFLOW_INTEGRATION :: WorkflowType |
Instances
ZendeskConnectorOperator
newtype ZendeskConnectorOperator Source #
Instances
AdditionalSearchKey
data AdditionalSearchKey Source #
A data type pair that consists of a KeyName
and Values
list that is
used in conjunction with the
KeyName
and
Values
parameters to search for profiles using the
SearchProfiles
API.
See: newAdditionalSearchKey
smart constructor.
Instances
newAdditionalSearchKey Source #
Create a value of AdditionalSearchKey
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:AdditionalSearchKey'
, additionalSearchKey_keyName
- A searchable identifier of a customer profile.
$sel:values:AdditionalSearchKey'
, additionalSearchKey_values
- A list of key values.
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:address1:Address'
, address_address1
- The first line of a customer address.
$sel:address2:Address'
, address_address2
- The second line of a customer address.
$sel:address3:Address'
, address_address3
- The third line of a customer address.
$sel:address4:Address'
, address_address4
- The fourth line of a customer address.
$sel:city:Address'
, address_city
- The city in which a customer lives.
$sel:country:Address'
, address_country
- The country in which a customer lives.
$sel:county:Address'
, address_county
- The county in which a customer lives.
$sel:postalCode:Address'
, address_postalCode
- The postal code of a customer address.
$sel:province:Address'
, address_province
- The province in which a customer lives.
$sel:state:Address'
, address_state
- The state in which a customer lives.
AppflowIntegration
data AppflowIntegration Source #
Details for workflow of type APPFLOW_INTEGRATION
.
See: newAppflowIntegration
smart constructor.
Instances
newAppflowIntegration Source #
Create a value of AppflowIntegration
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:batches:AppflowIntegration'
, appflowIntegration_batches
- Batches in workflow of type APPFLOW_INTEGRATION
.
$sel:flowDefinition:AppflowIntegration'
, appflowIntegration_flowDefinition
- Undocumented member.
AppflowIntegrationWorkflowAttributes
data AppflowIntegrationWorkflowAttributes Source #
Structure holding all APPFLOW_INTEGRATION
specific workflow
attributes.
See: newAppflowIntegrationWorkflowAttributes
smart constructor.
Instances
newAppflowIntegrationWorkflowAttributes Source #
:: SourceConnectorType |
|
-> Text |
|
-> AppflowIntegrationWorkflowAttributes |
Create a value of AppflowIntegrationWorkflowAttributes
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:roleArn:AppflowIntegrationWorkflowAttributes'
, appflowIntegrationWorkflowAttributes_roleArn
- The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
assumes this role to create resources on your behalf as part of workflow
execution.
$sel:sourceConnectorType:AppflowIntegrationWorkflowAttributes'
, appflowIntegrationWorkflowAttributes_sourceConnectorType
- Specifies the source connector type, such as Salesforce, ServiceNow, and
Marketo. Indicates source of ingestion.
$sel:connectorProfileName:AppflowIntegrationWorkflowAttributes'
, appflowIntegrationWorkflowAttributes_connectorProfileName
- The name of the AppFlow connector profile used for ingestion.
AppflowIntegrationWorkflowMetrics
data AppflowIntegrationWorkflowMetrics Source #
Workflow specific execution metrics for APPFLOW_INTEGRATION
workflow.
See: newAppflowIntegrationWorkflowMetrics
smart constructor.
Instances
newAppflowIntegrationWorkflowMetrics Source #
Create a value of AppflowIntegrationWorkflowMetrics
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:recordsProcessed:AppflowIntegrationWorkflowMetrics'
, appflowIntegrationWorkflowMetrics_recordsProcessed
- Number of records processed in APPFLOW_INTEGRATION
workflow.
$sel:stepsCompleted:AppflowIntegrationWorkflowMetrics'
, appflowIntegrationWorkflowMetrics_stepsCompleted
- Total steps completed in APPFLOW_INTEGRATION
workflow.
$sel:totalSteps:AppflowIntegrationWorkflowMetrics'
, appflowIntegrationWorkflowMetrics_totalSteps
- Total steps in APPFLOW_INTEGRATION
workflow.
AppflowIntegrationWorkflowStep
data AppflowIntegrationWorkflowStep Source #
Workflow step details for APPFLOW_INTEGRATION
workflow.
See: newAppflowIntegrationWorkflowStep
smart constructor.
Instances
newAppflowIntegrationWorkflowStep Source #
:: Text | |
-> Status | |
-> Text | |
-> Integer | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> AppflowIntegrationWorkflowStep |
Create a value of AppflowIntegrationWorkflowStep
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:flowName:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_flowName
- Name of the flow created during execution of workflow step.
APPFLOW_INTEGRATION
workflow type creates an appflow flow during
workflow step execution on the customers behalf.
$sel:status:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_status
- Workflow step status for APPFLOW_INTEGRATION
workflow.
$sel:executionMessage:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_executionMessage
- Message indicating execution of workflow step for APPFLOW_INTEGRATION
workflow.
$sel:recordsProcessed:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_recordsProcessed
- Total number of records processed during execution of workflow step for
APPFLOW_INTEGRATION
workflow.
$sel:batchRecordsStartTime:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_batchRecordsStartTime
- Start datetime of records pulled in batch during execution of workflow
step for APPFLOW_INTEGRATION
workflow.
$sel:batchRecordsEndTime:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_batchRecordsEndTime
- End datetime of records pulled in batch during execution of workflow
step for APPFLOW_INTEGRATION
workflow.
$sel:createdAt:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_createdAt
- Creation timestamp of workflow step for APPFLOW_INTEGRATION
workflow.
$sel:lastUpdatedAt:AppflowIntegrationWorkflowStep'
, appflowIntegrationWorkflowStep_lastUpdatedAt
- Last updated timestamp for workflow step for APPFLOW_INTEGRATION
workflow.
AutoMerging
data AutoMerging Source #
Configuration settings for how to perform the auto-merging of profiles.
See: newAutoMerging
smart constructor.
Instances
Create a value of AutoMerging
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:conflictResolution:AutoMerging'
, autoMerging_conflictResolution
- How the auto-merging process should resolve conflicts between different
profiles. For example, if Profile A and Profile B have the same
FirstName
and LastName
(and that is the matching criteria), which
EmailAddress
should be used?
$sel:consolidation:AutoMerging'
, autoMerging_consolidation
- A list of matching attributes that represent matching criteria. If two
profiles meet at least one of the requirements in the matching
attributes list, they will be merged.
$sel:minAllowedConfidenceScoreForMerging:AutoMerging'
, autoMerging_minAllowedConfidenceScoreForMerging
- A number between 0 and 1 that represents the minimum confidence score
required for profiles within a matching group to be merged during the
auto-merge process. A higher score means higher similarity required to
merge profiles.
$sel:enabled:AutoMerging'
, autoMerging_enabled
- The flag that enables the auto-merging of duplicate profiles.
Batch
Batch defines the boundaries for ingestion for each step in
APPFLOW_INTEGRATION
workflow. APPFLOW_INTEGRATION
workflow splits
ingestion based on these boundaries.
See: newBatch
smart constructor.
Instances
ToJSON Batch Source # | |
Defined in Amazonka.CustomerProfiles.Types.Batch | |
Generic Batch Source # | |
Read Batch Source # | |
Show Batch Source # | |
NFData Batch Source # | |
Defined in Amazonka.CustomerProfiles.Types.Batch | |
Eq Batch Source # | |
Hashable Batch Source # | |
Defined in Amazonka.CustomerProfiles.Types.Batch | |
type Rep Batch Source # | |
Defined in Amazonka.CustomerProfiles.Types.Batch type Rep Batch = D1 ('MetaData "Batch" "Amazonka.CustomerProfiles.Types.Batch" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "Batch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) |
Create a value of Batch
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:startTime:Batch'
, batch_startTime
- Start time of batch to split ingestion.
$sel:endTime:Batch'
, batch_endTime
- End time of batch to split ingestion.
ConflictResolution
data ConflictResolution Source #
How the auto-merging process should resolve conflicts between different profiles.
See: newConflictResolution
smart constructor.
Instances
newConflictResolution Source #
Create a value of ConflictResolution
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:ConflictResolution'
, conflictResolution_sourceName
- The ObjectType
name that is used to resolve profile merging conflicts
when choosing SOURCE
as the ConflictResolvingModel
.
$sel:conflictResolvingModel:ConflictResolution'
, conflictResolution_conflictResolvingModel
- How the auto-merging process should resolve conflicts between different
profiles.
RECENCY
: Uses the data that was most recently updated.SOURCE
: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, thenRECENCY
is used again.
ConnectorOperator
data ConnectorOperator Source #
The operation to be performed on the provided source fields.
See: newConnectorOperator
smart constructor.
ConnectorOperator' (Maybe MarketoConnectorOperator) (Maybe S3ConnectorOperator) (Maybe SalesforceConnectorOperator) (Maybe ServiceNowConnectorOperator) (Maybe ZendeskConnectorOperator) |
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:marketo:ConnectorOperator'
, connectorOperator_marketo
- The operation to be performed on the provided Marketo source fields.
$sel:s3:ConnectorOperator'
, connectorOperator_s3
- The operation to be performed on the provided Amazon S3 source fields.
$sel:salesforce:ConnectorOperator'
, connectorOperator_salesforce
- The operation to be performed on the provided Salesforce source fields.
$sel:serviceNow:ConnectorOperator'
, connectorOperator_serviceNow
- The operation to be performed on the provided ServiceNow source fields.
$sel:zendesk:ConnectorOperator'
, connectorOperator_zendesk
- The operation to be performed on the provided Zendesk source fields.
Consolidation
data Consolidation Source #
The matching criteria to be used during the auto-merging process.
See: newConsolidation
smart constructor.
Instances
Create a value of Consolidation
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:matchingAttributesList:Consolidation'
, consolidation_matchingAttributesList
- A list of matching criteria.
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:objectCount:DomainStats'
, domainStats_objectCount
- The total number of objects in domain.
$sel:profileCount:DomainStats'
, domainStats_profileCount
- The total number of profiles currently in the domain.
$sel:totalSize:DomainStats'
, domainStats_totalSize
- The total size, in bytes, of all objects in the domain.
ExportingConfig
data ExportingConfig Source #
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
See: newExportingConfig
smart constructor.
Instances
newExportingConfig :: ExportingConfig Source #
Create a value of ExportingConfig
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:s3Exporting:ExportingConfig'
, exportingConfig_s3Exporting
- The S3 location where Identity Resolution Jobs write result files.
ExportingLocation
data ExportingLocation Source #
The S3 location where Identity Resolution Jobs write result files.
See: newExportingLocation
smart constructor.
Instances
newExportingLocation :: ExportingLocation Source #
Create a value of ExportingLocation
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:s3Exporting:ExportingLocation'
, exportingLocation_s3Exporting
- Information about the S3 location where Identity Resolution Jobs write
result files.
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 (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe 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:accountNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_accountNumber
- A unique identifier for the account number field to be merged.
$sel:additionalInformation:FieldSourceProfileIds'
, fieldSourceProfileIds_additionalInformation
- A unique identifier for the additional information field to be merged.
$sel:address:FieldSourceProfileIds'
, fieldSourceProfileIds_address
- 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:billingAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_billingAddress
- A unique identifier for the billing type field to be merged.
$sel:birthDate:FieldSourceProfileIds'
, fieldSourceProfileIds_birthDate
- A unique identifier for the birthdate field to be merged.
$sel:businessEmailAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_businessEmailAddress
- A unique identifier for the party type field to be merged.
$sel:businessName:FieldSourceProfileIds'
, fieldSourceProfileIds_businessName
- A unique identifier for the business name field to be merged.
$sel:businessPhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_businessPhoneNumber
- A unique identifier for the business phone 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:gender:FieldSourceProfileIds'
, fieldSourceProfileIds_gender
- A unique identifier for the gender field to be merged.
$sel:homePhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_homePhoneNumber
- A unique identifier for the home phone number field to be merged.
$sel:lastName:FieldSourceProfileIds'
, fieldSourceProfileIds_lastName
- A unique identifier for the last name 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:mobilePhoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_mobilePhoneNumber
- A unique identifier for the mobile phone number field to be merged.
$sel:partyType:FieldSourceProfileIds'
, fieldSourceProfileIds_partyType
- A unique identifier for the party type field to be merged.
$sel:personalEmailAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_personalEmailAddress
- A unique identifier for the personal email address field to be merged.
$sel:phoneNumber:FieldSourceProfileIds'
, fieldSourceProfileIds_phoneNumber
- A unique identifier for the phone number field to be merged.
$sel:shippingAddress:FieldSourceProfileIds'
, fieldSourceProfileIds_shippingAddress
- A unique identifier for the shipping address 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.
FoundByKeyValue
data FoundByKeyValue Source #
A data type pair that consists of a KeyName
and Values
list that
were used to find a profile returned in response to a
SearchProfiles
request.
See: newFoundByKeyValue
smart constructor.
FoundByKeyValue' (Maybe Text) (Maybe [Text]) |
Instances
newFoundByKeyValue :: FoundByKeyValue Source #
Create a value of FoundByKeyValue
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:FoundByKeyValue'
, foundByKeyValue_keyName
- A searchable identifier of a customer profile.
$sel:values:FoundByKeyValue'
, foundByKeyValue_values
- A list of key values.
IdentityResolutionJob
data IdentityResolutionJob Source #
Information about the Identity Resolution Job.
See: newIdentityResolutionJob
smart constructor.
IdentityResolutionJob' (Maybe Text) (Maybe ExportingLocation) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe JobStats) (Maybe Text) (Maybe IdentityResolutionJobStatus) |
Instances
newIdentityResolutionJob :: IdentityResolutionJob Source #
Create a value of IdentityResolutionJob
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:IdentityResolutionJob'
, identityResolutionJob_domainName
- The unique name of the domain.
$sel:exportingLocation:IdentityResolutionJob'
, identityResolutionJob_exportingLocation
- The S3 location where the Identity Resolution Job writes result files.
$sel:jobEndTime:IdentityResolutionJob'
, identityResolutionJob_jobEndTime
- The timestamp of when the job was completed.
$sel:jobId:IdentityResolutionJob'
, identityResolutionJob_jobId
- The unique identifier of the Identity Resolution Job.
$sel:jobStartTime:IdentityResolutionJob'
, identityResolutionJob_jobStartTime
- The timestamp of when the job was started or will be started.
$sel:jobStats:IdentityResolutionJob'
, identityResolutionJob_jobStats
- Statistics about an Identity Resolution Job.
$sel:message:IdentityResolutionJob'
, identityResolutionJob_message
- The error messages that are generated when the Identity Resolution Job
runs.
$sel:status:IdentityResolutionJob'
, identityResolutionJob_status
- The status of the Identity Resolution Job.
PENDING
: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in thePENDING
state are deleted.PREPROCESSING
: The Identity Resolution Job is loading your data.FIND_MATCHING
: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.MERGING
: The Identity Resolution Job is merging duplicate profiles.COMPLETED
: The Identity Resolution Job completed successfully.PARTIAL_SUCCESS
: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.FAILED
: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
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.
IntegrationConfig
data IntegrationConfig Source #
Configuration data for integration workflow.
See: newIntegrationConfig
smart constructor.
Instances
newIntegrationConfig :: IntegrationConfig Source #
Create a value of IntegrationConfig
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:appflowIntegration:IntegrationConfig'
, integrationConfig_appflowIntegration
- Configuration data for APPFLOW_INTEGRATION
workflow type.
JobSchedule
data JobSchedule Source #
The day and time when do you want to start the Identity Resolution Job every week.
See: newJobSchedule
smart constructor.
Instances
Create a value of JobSchedule
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:dayOfTheWeek:JobSchedule'
, jobSchedule_dayOfTheWeek
- The day when the Identity Resolution Job should run every week.
$sel:time:JobSchedule'
, jobSchedule_time
- The time when the Identity Resolution Job should run every week.
JobStats
Statistics about the Identity Resolution Job.
See: newJobStats
smart constructor.
Instances
FromJSON JobStats Source # | |
Generic JobStats Source # | |
Read JobStats Source # | |
Show JobStats Source # | |
NFData JobStats Source # | |
Defined in Amazonka.CustomerProfiles.Types.JobStats | |
Eq JobStats Source # | |
Hashable JobStats Source # | |
Defined in Amazonka.CustomerProfiles.Types.JobStats | |
type Rep JobStats Source # | |
Defined in Amazonka.CustomerProfiles.Types.JobStats type Rep JobStats = D1 ('MetaData "JobStats" "Amazonka.CustomerProfiles.Types.JobStats" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "JobStats'" 'PrefixI 'True) (S1 ('MetaSel ('Just "numberOfMatchesFound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "numberOfMergesDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "numberOfProfilesReviewed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) |
newJobStats :: JobStats Source #
Create a value of JobStats
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:numberOfMatchesFound:JobStats'
, jobStats_numberOfMatchesFound
- The number of matches found.
$sel:numberOfMergesDone:JobStats'
, jobStats_numberOfMergesDone
- The number of merges completed.
$sel:numberOfProfilesReviewed:JobStats'
, jobStats_numberOfProfilesReviewed
- The number of profiles reviewed.
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.
ListIntegrationItem' (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text POSIX POSIX |
Instances
newListIntegrationItem Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> ListIntegrationItem |
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:isUnstructured:ListIntegrationItem'
, listIntegrationItem_isUnstructured
- Boolean to indicate if the Flow associated with the Integration is
created via Appflow console or with ObjectTypeName equals _unstructured
via API/CLI in flowDefinition
$sel:objectTypeName:ListIntegrationItem'
, listIntegrationItem_objectTypeName
- The name of the profile object type.
$sel:objectTypeNames:ListIntegrationItem'
, listIntegrationItem_objectTypeNames
- A map in which each key is an event type from an external application
such as Segment or Shopify, and each value is an ObjectTypeName
(template) used to ingest the event. It supports the following event
types: SegmentIdentify
, ShopifyCreateCustomers
,
ShopifyUpdateCustomers
, ShopifyCreateDraftOrders
,
ShopifyUpdateDraftOrders
, ShopifyCreateOrders
, and
ShopifyUpdatedOrders
.
$sel:tags:ListIntegrationItem'
, listIntegrationItem_tags
- The tags used to organize, track, or control access for this resource.
$sel:workflowId:ListIntegrationItem'
, listIntegrationItem_workflowId
- Unique identifier for the workflow.
$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: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:createdAt:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_createdAt
- The timestamp of when the domain was created.
$sel:lastUpdatedAt:ListProfileObjectTypeItem'
, listProfileObjectTypeItem_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
$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:sourceObject:ListProfileObjectTypeTemplateItem'
, listProfileObjectTypeTemplateItem_sourceObject
- The source of the object template.
$sel:templateId:ListProfileObjectTypeTemplateItem'
, listProfileObjectTypeTemplateItem_templateId
- A unique identifier for 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:object':ListProfileObjectsItem'
, listProfileObjectsItem_object
- A JSON representation of a ProfileObject that belongs to a profile.
$sel:objectTypeName:ListProfileObjectsItem'
, listProfileObjectsItem_objectTypeName
- Specifies the kind of object being added to a profile, such as
"Salesforce-Account."
$sel:profileObjectUniqueKey:ListProfileObjectsItem'
, listProfileObjectsItem_profileObjectUniqueKey
- The unique identifier of the ProfileObject generated by the service.
ListWorkflowsItem
data ListWorkflowsItem Source #
A workflow in list of workflows.
See: newListWorkflowsItem
smart constructor.
Instances
:: WorkflowType | |
-> Text | |
-> Status | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> ListWorkflowsItem |
Create a value of ListWorkflowsItem
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:workflowType:ListWorkflowsItem'
, listWorkflowsItem_workflowType
- The type of workflow. The only supported value is APPFLOW_INTEGRATION.
$sel:workflowId:ListWorkflowsItem'
, listWorkflowsItem_workflowId
- Unique identifier for the workflow.
$sel:status:ListWorkflowsItem'
, listWorkflowsItem_status
- Status of workflow execution.
$sel:statusDescription:ListWorkflowsItem'
, listWorkflowsItem_statusDescription
- Description for workflow execution status.
$sel:createdAt:ListWorkflowsItem'
, listWorkflowsItem_createdAt
- Creation timestamp for workflow.
$sel:lastUpdatedAt:ListWorkflowsItem'
, listWorkflowsItem_lastUpdatedAt
- Last updated timestamp for workflow.
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.
Instances
FromJSON MatchItem Source # | |
Generic MatchItem Source # | |
Read MatchItem Source # | |
Show MatchItem Source # | |
NFData MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
Eq MatchItem Source # | |
Hashable MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
type Rep MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem type Rep MatchItem = D1 ('MetaData "MatchItem" "Amazonka.CustomerProfiles.Types.MatchItem" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "MatchItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "confidenceScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "matchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "profileIds") '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:confidenceScore:MatchItem'
, matchItem_confidenceScore
- A number between 0 and 1, where a higher score means higher similarity.
Examining match confidence scores lets you distinguish between groups of
similar records in which the system is highly confident (which you may
decide to merge), groups of similar records about which the system is
uncertain (which you may decide to have reviewed by a human), and groups
of similar records that the system deems to be unlikely (which you may
decide to reject). Given confidence scores vary as per the data input,
it should not be used an absolute measure of matching quality.
$sel:matchId:MatchItem'
, matchItem_matchId
- The unique identifiers for this group of profiles that match.
$sel:profileIds:MatchItem'
, matchItem_profileIds
- A list of identifiers for 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:autoMerging:MatchingRequest'
, matchingRequest_autoMerging
- Configuration information about the auto-merging process.
$sel:exportingConfig:MatchingRequest'
, matchingRequest_exportingConfig
- Configuration information for exporting Identity Resolution results, for
example, to an S3 bucket.
$sel:jobSchedule:MatchingRequest'
, matchingRequest_jobSchedule
- The day and time when do you want to start the Identity Resolution Job
every week.
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:autoMerging:MatchingResponse'
, matchingResponse_autoMerging
- Configuration information about the auto-merging process.
MatchingResponse
, matchingResponse_enabled
- The flag that enables the matching process of duplicate profiles.
$sel:exportingConfig:MatchingResponse'
, matchingResponse_exportingConfig
- Configuration information for exporting Identity Resolution results, for
example, to an S3 bucket.
$sel:jobSchedule:MatchingResponse'
, matchingResponse_jobSchedule
- The day and time when do you want to start the Identity Resolution Job
every week.
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, _case and _order.
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. The predefined keys you can use to search for _order
include: _orderId.
$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:contentType:ObjectTypeField'
, objectTypeField_contentType
- The content type of the field. Used for determining equality when
searching.
$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: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, CASE,
or ORDER means that this key can be used to tie an object to a PROFILE,
ASSET, CASE, or ORDER 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 Text) (Maybe Text) (Maybe Address) (Maybe (HashMap Text Text)) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty FoundByKeyValue)) (Maybe Gender) (Maybe Text) (Maybe Text) (Maybe Address) (Maybe Text) (Maybe Text) (Maybe PartyType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Address) |
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:accountNumber:Profile'
, profile_accountNumber
- A unique account number that you have given to the customer.
$sel:additionalInformation:Profile'
, profile_additionalInformation
- Any additional information relevant to the customer’s profile.
$sel:address:Profile'
, profile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
$sel:attributes:Profile'
, profile_attributes
- A key value pair of attributes of a customer profile.
$sel:billingAddress:Profile'
, profile_billingAddress
- The customer’s billing address.
$sel:birthDate:Profile'
, profile_birthDate
- The customer’s birth date.
$sel:businessEmailAddress:Profile'
, profile_businessEmailAddress
- The customer’s business email address.
$sel:businessName:Profile'
, profile_businessName
- The name of the customer’s business.
$sel:businessPhoneNumber:Profile'
, profile_businessPhoneNumber
- The customer’s home phone number.
$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:foundByItems:Profile'
, profile_foundByItems
- A list of items used to find a profile returned in a
SearchProfiles
response. An item is a key-value(s) pair that matches an attribute in
the profile.
If the optional AdditionalSearchKeys
parameter was included in the
SearchProfiles
request, the FoundByItems
list should be interpreted based on the
LogicalOperator
used in the request:
AND
- The profile included in the response matched all of the search keys specified in the request. TheFoundByItems
will include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofAND
search logic).OR
- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItems
will include each of the key-value(s) pairs that the profile was found by.
The OR
relationship is the default behavior if the LogicalOperator
parameter is not included in the
SearchProfiles
request.
$sel:gender:Profile'
, profile_gender
- The gender with which the customer identifies.
$sel:homePhoneNumber:Profile'
, profile_homePhoneNumber
- The customer’s home phone number.
$sel:lastName:Profile'
, profile_lastName
- The customer’s last name.
$sel:mailingAddress:Profile'
, profile_mailingAddress
- The customer’s mailing address.
$sel:middleName:Profile'
, profile_middleName
- The customer’s middle name.
$sel:mobilePhoneNumber:Profile'
, profile_mobilePhoneNumber
- The customer’s mobile phone number.
$sel:partyType:Profile'
, profile_partyType
- The type of profile used to describe the customer.
$sel:personalEmailAddress:Profile'
, profile_personalEmailAddress
- The customer’s personal email address.
$sel:phoneNumber:Profile'
, profile_phoneNumber
- The customer's phone number, which has not been specified as a mobile,
home, or business number.
$sel:profileId:Profile'
, profile_profileId
- The unique identifier of a customer profile.
$sel:shippingAddress:Profile'
, profile_shippingAddress
- The customer’s shipping address.
S3ExportingConfig
data S3ExportingConfig Source #
Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
See: newS3ExportingConfig
smart constructor.
Instances
Create a value of S3ExportingConfig
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:s3KeyName:S3ExportingConfig'
, s3ExportingConfig_s3KeyName
- The S3 key name of the location where Identity Resolution Jobs write
result files.
$sel:s3BucketName:S3ExportingConfig'
, s3ExportingConfig_s3BucketName
- The name of the S3 bucket where Identity Resolution Jobs write result
files.
S3ExportingLocation
data S3ExportingLocation Source #
The S3 location where Identity Resolution Jobs write result files.
See: newS3ExportingLocation
smart constructor.
Instances
newS3ExportingLocation :: S3ExportingLocation Source #
Create a value of S3ExportingLocation
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:s3BucketName:S3ExportingLocation'
, s3ExportingLocation_s3BucketName
- The name of the S3 bucket name where Identity Resolution Jobs write
result files.
$sel:s3KeyName:S3ExportingLocation'
, s3ExportingLocation_s3KeyName
- The S3 key name of the location where Identity Resolution Jobs write
result files.
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 DataPullMode) (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) 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:dataPullMode:ScheduledTriggerProperties'
, scheduledTriggerProperties_dataPullMode
- Specifies whether a scheduled flow has an incremental data transfer or a
complete data transfer for each flow run.
$sel:firstExecutionFrom:ScheduledTriggerProperties'
, scheduledTriggerProperties_firstExecutionFrom
- Specifies the date range for the records to import from the connector in
the first flow run.
$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: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: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 MarketoSourceProperties) (Maybe S3SourceProperties) (Maybe SalesforceSourceProperties) (Maybe ServiceNowSourceProperties) (Maybe ZendeskSourceProperties) |
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:marketo:SourceConnectorProperties'
, sourceConnectorProperties_marketo
- The properties that are applied when Marketo is being used as a source.
$sel:s3:SourceConnectorProperties'
, sourceConnectorProperties_s3
- The properties that are applied when Amazon S3 is being used as the flow
source.
$sel:salesforce:SourceConnectorProperties'
, sourceConnectorProperties_salesforce
- The properties that are applied when Salesforce is being used as a
source.
$sel:serviceNow:SourceConnectorProperties'
, sourceConnectorProperties_serviceNow
- The properties that are applied when ServiceNow is being used as a
source.
$sel:zendesk:SourceConnectorProperties'
, sourceConnectorProperties_zendesk
- The properties that are applied when using Zendesk as a 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 ConnectorOperator) (Maybe Text) (Maybe (HashMap OperatorPropertiesKeys 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: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:taskProperties:Task'
, task_taskProperties
- A map used to store task-related information. The service looks for
particular information based on the TaskType.
$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:address1:UpdateAddress'
, updateAddress_address1
- The first line of a customer address.
$sel:address2:UpdateAddress'
, updateAddress_address2
- The second line of a customer address.
$sel:address3:UpdateAddress'
, updateAddress_address3
- The third line of a customer address.
$sel:address4:UpdateAddress'
, updateAddress_address4
- The fourth line of a customer address.
$sel:city:UpdateAddress'
, updateAddress_city
- The city in which a customer lives.
$sel:country:UpdateAddress'
, updateAddress_country
- The country in which a customer lives.
$sel:county:UpdateAddress'
, updateAddress_county
- The county in which a customer lives.
$sel:postalCode:UpdateAddress'
, updateAddress_postalCode
- The postal code of a customer address.
$sel:province:UpdateAddress'
, updateAddress_province
- The province in which a customer lives.
$sel:state:UpdateAddress'
, updateAddress_state
- The state in which a customer lives.
WorkflowAttributes
data WorkflowAttributes Source #
Structure to hold workflow attributes.
See: newWorkflowAttributes
smart constructor.
Instances
newWorkflowAttributes :: WorkflowAttributes Source #
Create a value of WorkflowAttributes
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:appflowIntegration:WorkflowAttributes'
, workflowAttributes_appflowIntegration
- Workflow attributes specific to APPFLOW_INTEGRATION
workflow.
WorkflowMetrics
data WorkflowMetrics Source #
Generic object containing workflow execution metrics.
See: newWorkflowMetrics
smart constructor.
Instances
newWorkflowMetrics :: WorkflowMetrics Source #
Create a value of WorkflowMetrics
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:appflowIntegration:WorkflowMetrics'
, workflowMetrics_appflowIntegration
- Workflow execution metrics for APPFLOW_INTEGRATION
workflow.
WorkflowStepItem
data WorkflowStepItem Source #
List containing steps in workflow.
See: newWorkflowStepItem
smart constructor.
Instances
newWorkflowStepItem :: WorkflowStepItem Source #
Create a value of WorkflowStepItem
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:appflowIntegration:WorkflowStepItem'
, workflowStepItem_appflowIntegration
- Workflow step information specific to APPFLOW_INTEGRATION
workflow.
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.