| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CustomerProfiles.Types
Contents
- Service Configuration
- Errors
- DataPullMode
- FieldContentType
- Gender
- MarketoConnectorOperator
- OperatorPropertiesKeys
- PartyType
- S3ConnectorOperator
- SalesforceConnectorOperator
- ServiceNowConnectorOperator
- SourceConnectorType
- StandardIdentifier
- TaskType
- TriggerType
- ZendeskConnectorOperator
- Address
- ConnectorOperator
- DomainStats
- FieldSourceProfileIds
- FlowDefinition
- IncrementalPullConfig
- ListDomainItem
- ListIntegrationItem
- ListProfileObjectTypeItem
- ListProfileObjectTypeTemplateItem
- ListProfileObjectsItem
- MarketoSourceProperties
- MatchItem
- MatchingRequest
- MatchingResponse
- ObjectFilter
- ObjectTypeField
- ObjectTypeKey
- Profile
- S3SourceProperties
- SalesforceSourceProperties
- ScheduledTriggerProperties
- ServiceNowSourceProperties
- SourceConnectorProperties
- SourceFlowConfig
- Task
- TriggerConfig
- TriggerProperties
- UpdateAddress
- ZendeskSourceProperties
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype DataPullMode where
- DataPullMode' { }
- pattern DataPullMode_Complete :: DataPullMode
- pattern DataPullMode_Incremental :: DataPullMode
- newtype FieldContentType where
- FieldContentType' { }
- pattern FieldContentType_EMAIL_ADDRESS :: FieldContentType
- pattern FieldContentType_NAME :: FieldContentType
- pattern FieldContentType_NUMBER :: FieldContentType
- pattern FieldContentType_PHONE_NUMBER :: FieldContentType
- pattern FieldContentType_STRING :: FieldContentType
- newtype Gender where
- Gender' {
- fromGender :: Text
- pattern Gender_FEMALE :: Gender
- pattern Gender_MALE :: Gender
- pattern Gender_UNSPECIFIED :: Gender
- Gender' {
- newtype MarketoConnectorOperator where
- MarketoConnectorOperator' { }
- pattern MarketoConnectorOperator_ADDITION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_BETWEEN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_DIVISION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_GREATER_THAN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_LESS_THAN :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_ALL :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_FIRST_N :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MASK_LAST_N :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_MULTIPLICATION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_NO_OP :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_PROJECTION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_SUBTRACTION :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_NEGATIVE :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_NULL :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NON_ZERO :: MarketoConnectorOperator
- pattern MarketoConnectorOperator_VALIDATE_NUMERIC :: MarketoConnectorOperator
- newtype OperatorPropertiesKeys where
- OperatorPropertiesKeys' { }
- pattern OperatorPropertiesKeys_CONCAT_FORMAT :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_DESTINATION_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_LOWER_BOUND :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MASK_LENGTH :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MASK_VALUE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_MATH_OPERATION_FIELDS_ORDER :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_SOURCE_DATA_TYPE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_SUBFIELD_CATEGORY_MAP :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_TRUNCATE_LENGTH :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_UPPER_BOUND :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALIDATION_ACTION :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALUE :: OperatorPropertiesKeys
- pattern OperatorPropertiesKeys_VALUES :: OperatorPropertiesKeys
- newtype PartyType where
- PartyType' { }
- pattern PartyType_BUSINESS :: PartyType
- pattern PartyType_INDIVIDUAL :: PartyType
- pattern PartyType_OTHER :: PartyType
- newtype S3ConnectorOperator where
- S3ConnectorOperator' { }
- pattern S3ConnectorOperator_ADDITION :: S3ConnectorOperator
- pattern S3ConnectorOperator_BETWEEN :: S3ConnectorOperator
- pattern S3ConnectorOperator_DIVISION :: S3ConnectorOperator
- pattern S3ConnectorOperator_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_GREATER_THAN :: S3ConnectorOperator
- pattern S3ConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_LESS_THAN :: S3ConnectorOperator
- pattern S3ConnectorOperator_LESS_THAN_OR_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_ALL :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_FIRST_N :: S3ConnectorOperator
- pattern S3ConnectorOperator_MASK_LAST_N :: S3ConnectorOperator
- pattern S3ConnectorOperator_MULTIPLICATION :: S3ConnectorOperator
- pattern S3ConnectorOperator_NOT_EQUAL_TO :: S3ConnectorOperator
- pattern S3ConnectorOperator_NO_OP :: S3ConnectorOperator
- pattern S3ConnectorOperator_PROJECTION :: S3ConnectorOperator
- pattern S3ConnectorOperator_SUBTRACTION :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_NEGATIVE :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_NULL :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NON_ZERO :: S3ConnectorOperator
- pattern S3ConnectorOperator_VALIDATE_NUMERIC :: S3ConnectorOperator
- newtype SalesforceConnectorOperator where
- SalesforceConnectorOperator' { }
- pattern SalesforceConnectorOperator_ADDITION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_BETWEEN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_CONTAINS :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_DIVISION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_GREATER_THAN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_LESS_THAN :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_LESS_THAN_OR_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_ALL :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_FIRST_N :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MASK_LAST_N :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_MULTIPLICATION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_NOT_EQUAL_TO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_NO_OP :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_PROJECTION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_SUBTRACTION :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_NEGATIVE :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_NULL :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NON_ZERO :: SalesforceConnectorOperator
- pattern SalesforceConnectorOperator_VALIDATE_NUMERIC :: SalesforceConnectorOperator
- newtype ServiceNowConnectorOperator where
- ServiceNowConnectorOperator' { }
- pattern ServiceNowConnectorOperator_ADDITION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_BETWEEN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_CONTAINS :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_DIVISION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_GREATER_THAN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_GREATER_THAN_OR_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_LESS_THAN :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_LESS_THAN_OR_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_ALL :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_FIRST_N :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MASK_LAST_N :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_MULTIPLICATION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_NOT_EQUAL_TO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_NO_OP :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_PROJECTION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_SUBTRACTION :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_NEGATIVE :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_NULL :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NON_ZERO :: ServiceNowConnectorOperator
- pattern ServiceNowConnectorOperator_VALIDATE_NUMERIC :: ServiceNowConnectorOperator
- newtype SourceConnectorType where
- SourceConnectorType' { }
- pattern SourceConnectorType_Marketo :: SourceConnectorType
- pattern SourceConnectorType_S3 :: SourceConnectorType
- pattern SourceConnectorType_Salesforce :: SourceConnectorType
- pattern SourceConnectorType_Servicenow :: SourceConnectorType
- pattern SourceConnectorType_Zendesk :: SourceConnectorType
- newtype StandardIdentifier where
- StandardIdentifier' { }
- pattern StandardIdentifier_ASSET :: StandardIdentifier
- pattern StandardIdentifier_CASE :: StandardIdentifier
- pattern StandardIdentifier_LOOKUP_ONLY :: StandardIdentifier
- pattern StandardIdentifier_NEW_ONLY :: StandardIdentifier
- pattern StandardIdentifier_PROFILE :: StandardIdentifier
- pattern StandardIdentifier_SECONDARY :: StandardIdentifier
- pattern StandardIdentifier_UNIQUE :: StandardIdentifier
- newtype TaskType where
- TaskType' {
- fromTaskType :: Text
- pattern TaskType_Arithmetic :: TaskType
- pattern TaskType_Filter :: TaskType
- pattern TaskType_Map :: TaskType
- pattern TaskType_Mask :: TaskType
- pattern TaskType_Merge :: TaskType
- pattern TaskType_Truncate :: TaskType
- pattern TaskType_Validate :: TaskType
- TaskType' {
- newtype TriggerType where
- TriggerType' { }
- pattern TriggerType_Event :: TriggerType
- pattern TriggerType_OnDemand :: TriggerType
- pattern TriggerType_Scheduled :: TriggerType
- newtype ZendeskConnectorOperator where
- ZendeskConnectorOperator' { }
- pattern ZendeskConnectorOperator_ADDITION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_DIVISION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_GREATER_THAN :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_ALL :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_FIRST_N :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MASK_LAST_N :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_MULTIPLICATION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_NO_OP :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_PROJECTION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_SUBTRACTION :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_NEGATIVE :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_NULL :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NON_ZERO :: ZendeskConnectorOperator
- pattern ZendeskConnectorOperator_VALIDATE_NUMERIC :: ZendeskConnectorOperator
- data Address = Address' {}
- newAddress :: Address
- address_address2 :: Lens' Address (Maybe Text)
- address_state :: Lens' Address (Maybe Text)
- address_address4 :: Lens' Address (Maybe Text)
- address_county :: Lens' Address (Maybe Text)
- address_address3 :: Lens' Address (Maybe Text)
- address_postalCode :: Lens' Address (Maybe Text)
- address_country :: Lens' Address (Maybe Text)
- address_city :: Lens' Address (Maybe Text)
- address_address1 :: Lens' Address (Maybe Text)
- address_province :: Lens' Address (Maybe Text)
- data ConnectorOperator = ConnectorOperator' {}
- newConnectorOperator :: ConnectorOperator
- connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator)
- connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator)
- connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator)
- connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator)
- connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator)
- data DomainStats = DomainStats' {}
- newDomainStats :: DomainStats
- domainStats_meteringProfileCount :: Lens' DomainStats (Maybe Integer)
- domainStats_totalSize :: Lens' DomainStats (Maybe Integer)
- domainStats_profileCount :: Lens' DomainStats (Maybe Integer)
- domainStats_objectCount :: Lens' DomainStats (Maybe Integer)
- data FieldSourceProfileIds = FieldSourceProfileIds' {
- shippingAddress :: Maybe Text
- mobilePhoneNumber :: Maybe Text
- mailingAddress :: Maybe Text
- middleName :: Maybe Text
- personalEmailAddress :: Maybe Text
- lastName :: Maybe Text
- additionalInformation :: Maybe Text
- homePhoneNumber :: Maybe Text
- address :: Maybe Text
- partyType :: Maybe Text
- businessEmailAddress :: Maybe Text
- attributes :: Maybe (HashMap Text Text)
- gender :: Maybe Text
- phoneNumber :: Maybe Text
- accountNumber :: Maybe Text
- emailAddress :: Maybe Text
- firstName :: Maybe Text
- billingAddress :: Maybe Text
- businessPhoneNumber :: Maybe Text
- birthDate :: Maybe Text
- businessName :: Maybe Text
- newFieldSourceProfileIds :: FieldSourceProfileIds
- fieldSourceProfileIds_shippingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_mobilePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_mailingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_middleName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_personalEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_lastName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_additionalInformation :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_homePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_address :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_partyType :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_attributes :: Lens' FieldSourceProfileIds (Maybe (HashMap Text Text))
- fieldSourceProfileIds_gender :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_phoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_accountNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_emailAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_firstName :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_billingAddress :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessPhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_birthDate :: Lens' FieldSourceProfileIds (Maybe Text)
- fieldSourceProfileIds_businessName :: Lens' FieldSourceProfileIds (Maybe Text)
- data FlowDefinition = FlowDefinition' {}
- newFlowDefinition :: Text -> Text -> SourceFlowConfig -> TriggerConfig -> FlowDefinition
- flowDefinition_description :: Lens' FlowDefinition (Maybe Text)
- flowDefinition_flowName :: Lens' FlowDefinition Text
- flowDefinition_kmsArn :: Lens' FlowDefinition Text
- flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig
- flowDefinition_tasks :: Lens' FlowDefinition [Task]
- flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig
- data IncrementalPullConfig = IncrementalPullConfig' {}
- newIncrementalPullConfig :: IncrementalPullConfig
- incrementalPullConfig_datetimeTypeFieldName :: Lens' IncrementalPullConfig (Maybe Text)
- data ListDomainItem = ListDomainItem' {}
- newListDomainItem :: Text -> UTCTime -> UTCTime -> ListDomainItem
- listDomainItem_tags :: Lens' ListDomainItem (Maybe (HashMap Text Text))
- listDomainItem_domainName :: Lens' ListDomainItem Text
- listDomainItem_createdAt :: Lens' ListDomainItem UTCTime
- listDomainItem_lastUpdatedAt :: Lens' ListDomainItem UTCTime
- data ListIntegrationItem = ListIntegrationItem' {
- tags :: Maybe (HashMap Text Text)
- domainName :: Text
- uri :: Text
- objectTypeName :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
- newListIntegrationItem :: Text -> Text -> Text -> UTCTime -> UTCTime -> ListIntegrationItem
- listIntegrationItem_tags :: Lens' ListIntegrationItem (Maybe (HashMap Text Text))
- listIntegrationItem_domainName :: Lens' ListIntegrationItem Text
- listIntegrationItem_uri :: Lens' ListIntegrationItem Text
- listIntegrationItem_objectTypeName :: Lens' ListIntegrationItem Text
- listIntegrationItem_createdAt :: Lens' ListIntegrationItem UTCTime
- listIntegrationItem_lastUpdatedAt :: Lens' ListIntegrationItem UTCTime
- data ListProfileObjectTypeItem = ListProfileObjectTypeItem' {
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- tags :: Maybe (HashMap Text Text)
- objectTypeName :: Text
- description :: Text
- newListProfileObjectTypeItem :: Text -> Text -> ListProfileObjectTypeItem
- listProfileObjectTypeItem_lastUpdatedAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime)
- listProfileObjectTypeItem_createdAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime)
- listProfileObjectTypeItem_tags :: Lens' ListProfileObjectTypeItem (Maybe (HashMap Text Text))
- listProfileObjectTypeItem_objectTypeName :: Lens' ListProfileObjectTypeItem Text
- listProfileObjectTypeItem_description :: Lens' ListProfileObjectTypeItem Text
- data ListProfileObjectTypeTemplateItem = ListProfileObjectTypeTemplateItem' {
- sourceName :: Maybe Text
- templateId :: Maybe Text
- sourceObject :: Maybe Text
- newListProfileObjectTypeTemplateItem :: ListProfileObjectTypeTemplateItem
- listProfileObjectTypeTemplateItem_sourceName :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- listProfileObjectTypeTemplateItem_templateId :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- listProfileObjectTypeTemplateItem_sourceObject :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text)
- data ListProfileObjectsItem = ListProfileObjectsItem' {}
- newListProfileObjectsItem :: ListProfileObjectsItem
- listProfileObjectsItem_profileObjectUniqueKey :: Lens' ListProfileObjectsItem (Maybe Text)
- listProfileObjectsItem_objectTypeName :: Lens' ListProfileObjectsItem (Maybe Text)
- listProfileObjectsItem_object :: Lens' ListProfileObjectsItem (Maybe Text)
- data MarketoSourceProperties = MarketoSourceProperties' {}
- newMarketoSourceProperties :: Text -> MarketoSourceProperties
- marketoSourceProperties_object :: Lens' MarketoSourceProperties Text
- data MatchItem = MatchItem' {}
- newMatchItem :: MatchItem
- matchItem_profileIds :: Lens' MatchItem (Maybe [Text])
- matchItem_matchId :: Lens' MatchItem (Maybe Text)
- data MatchingRequest = MatchingRequest' {}
- newMatchingRequest :: Bool -> MatchingRequest
- matchingRequest_enabled :: Lens' MatchingRequest Bool
- data MatchingResponse = MatchingResponse' {}
- newMatchingResponse :: MatchingResponse
- matchingResponse_enabled :: Lens' MatchingResponse (Maybe Bool)
- data ObjectFilter = ObjectFilter' {}
- newObjectFilter :: Text -> ObjectFilter
- objectFilter_keyName :: Lens' ObjectFilter Text
- objectFilter_values :: Lens' ObjectFilter [Text]
- data ObjectTypeField = ObjectTypeField' {}
- newObjectTypeField :: ObjectTypeField
- objectTypeField_source :: Lens' ObjectTypeField (Maybe Text)
- objectTypeField_contentType :: Lens' ObjectTypeField (Maybe FieldContentType)
- objectTypeField_target :: Lens' ObjectTypeField (Maybe Text)
- data ObjectTypeKey = ObjectTypeKey' {}
- newObjectTypeKey :: ObjectTypeKey
- objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text])
- objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier])
- data Profile = Profile' {
- shippingAddress :: Maybe Address
- mobilePhoneNumber :: Maybe Text
- mailingAddress :: Maybe Address
- middleName :: Maybe Text
- personalEmailAddress :: Maybe Text
- lastName :: Maybe Text
- additionalInformation :: Maybe Text
- homePhoneNumber :: Maybe Text
- address :: Maybe Address
- partyType :: Maybe PartyType
- profileId :: Maybe Text
- businessEmailAddress :: Maybe Text
- attributes :: Maybe (HashMap Text Text)
- gender :: Maybe Gender
- phoneNumber :: Maybe Text
- accountNumber :: Maybe Text
- emailAddress :: Maybe Text
- firstName :: Maybe Text
- billingAddress :: Maybe Address
- businessPhoneNumber :: Maybe Text
- birthDate :: Maybe Text
- businessName :: Maybe Text
- newProfile :: Profile
- profile_shippingAddress :: Lens' Profile (Maybe Address)
- profile_mobilePhoneNumber :: Lens' Profile (Maybe Text)
- profile_mailingAddress :: Lens' Profile (Maybe Address)
- profile_middleName :: Lens' Profile (Maybe Text)
- profile_personalEmailAddress :: Lens' Profile (Maybe Text)
- profile_lastName :: Lens' Profile (Maybe Text)
- profile_additionalInformation :: Lens' Profile (Maybe Text)
- profile_homePhoneNumber :: Lens' Profile (Maybe Text)
- profile_address :: Lens' Profile (Maybe Address)
- profile_partyType :: Lens' Profile (Maybe PartyType)
- profile_profileId :: Lens' Profile (Maybe Text)
- profile_businessEmailAddress :: Lens' Profile (Maybe Text)
- profile_attributes :: Lens' Profile (Maybe (HashMap Text Text))
- profile_gender :: Lens' Profile (Maybe Gender)
- profile_phoneNumber :: Lens' Profile (Maybe Text)
- profile_accountNumber :: Lens' Profile (Maybe Text)
- profile_emailAddress :: Lens' Profile (Maybe Text)
- profile_firstName :: Lens' Profile (Maybe Text)
- profile_billingAddress :: Lens' Profile (Maybe Address)
- profile_businessPhoneNumber :: Lens' Profile (Maybe Text)
- profile_birthDate :: Lens' Profile (Maybe Text)
- profile_businessName :: Lens' Profile (Maybe Text)
- data S3SourceProperties = S3SourceProperties' {
- bucketPrefix :: Maybe Text
- bucketName :: Text
- newS3SourceProperties :: Text -> S3SourceProperties
- s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text)
- s3SourceProperties_bucketName :: Lens' S3SourceProperties Text
- data SalesforceSourceProperties = SalesforceSourceProperties' {}
- newSalesforceSourceProperties :: Text -> SalesforceSourceProperties
- salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool)
- salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool)
- salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text
- data ScheduledTriggerProperties = ScheduledTriggerProperties' {}
- newScheduledTriggerProperties :: Text -> ScheduledTriggerProperties
- scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural)
- scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode)
- scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text)
- scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime)
- scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text
- data ServiceNowSourceProperties = ServiceNowSourceProperties' {}
- newServiceNowSourceProperties :: Text -> ServiceNowSourceProperties
- serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text
- data SourceConnectorProperties = SourceConnectorProperties' {}
- newSourceConnectorProperties :: SourceConnectorProperties
- sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties)
- sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties)
- sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties)
- sourceConnectorProperties_zendesk :: Lens' SourceConnectorProperties (Maybe ZendeskSourceProperties)
- sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties)
- data SourceFlowConfig = SourceFlowConfig' {}
- newSourceFlowConfig :: SourceConnectorType -> SourceConnectorProperties -> SourceFlowConfig
- sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text)
- sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig)
- sourceFlowConfig_connectorType :: Lens' SourceFlowConfig SourceConnectorType
- sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties
- data Task = Task' {}
- newTask :: TaskType -> Task
- task_taskProperties :: Lens' Task (Maybe (HashMap OperatorPropertiesKeys Text))
- task_connectorOperator :: Lens' Task (Maybe ConnectorOperator)
- task_destinationField :: Lens' Task (Maybe Text)
- task_sourceFields :: Lens' Task [Text]
- task_taskType :: Lens' Task TaskType
- data TriggerConfig = TriggerConfig' {}
- newTriggerConfig :: TriggerType -> TriggerConfig
- triggerConfig_triggerProperties :: Lens' TriggerConfig (Maybe TriggerProperties)
- triggerConfig_triggerType :: Lens' TriggerConfig TriggerType
- data TriggerProperties = TriggerProperties' {}
- newTriggerProperties :: TriggerProperties
- triggerProperties_scheduled :: Lens' TriggerProperties (Maybe ScheduledTriggerProperties)
- data UpdateAddress = UpdateAddress' {}
- newUpdateAddress :: UpdateAddress
- updateAddress_address2 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_state :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address4 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_county :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address3 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_postalCode :: Lens' UpdateAddress (Maybe Text)
- updateAddress_country :: Lens' UpdateAddress (Maybe Text)
- updateAddress_city :: Lens' UpdateAddress (Maybe Text)
- updateAddress_address1 :: Lens' UpdateAddress (Maybe Text)
- updateAddress_province :: Lens' UpdateAddress (Maybe Text)
- data ZendeskSourceProperties = ZendeskSourceProperties' {}
- newZendeskSourceProperties :: Text -> ZendeskSourceProperties
- zendeskSourceProperties_object :: Lens' ZendeskSourceProperties Text
Service Configuration
defaultService :: Service Source #
API version 2020-08-15 of the Amazon Connect Customer Profiles SDK configuration.
Errors
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You exceeded the maximum number of requests.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal service error occurred.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist, or access was denied.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input you provided is invalid.
DataPullMode
newtype DataPullMode Source #
Constructors
| DataPullMode' | |
Fields | |
Bundled Patterns
| pattern DataPullMode_Complete :: DataPullMode | |
| pattern DataPullMode_Incremental :: DataPullMode |
Instances
FieldContentType
newtype FieldContentType Source #
Constructors
| FieldContentType' | |
Fields | |
Bundled Patterns
| pattern FieldContentType_EMAIL_ADDRESS :: FieldContentType | |
| pattern FieldContentType_NAME :: FieldContentType | |
| pattern FieldContentType_NUMBER :: FieldContentType | |
| pattern FieldContentType_PHONE_NUMBER :: FieldContentType | |
| pattern FieldContentType_STRING :: FieldContentType |
Instances
Gender
Constructors
| Gender' | |
Fields
| |
Bundled Patterns
| pattern Gender_FEMALE :: Gender | |
| pattern Gender_MALE :: Gender | |
| pattern Gender_UNSPECIFIED :: Gender |
Instances
MarketoConnectorOperator
newtype MarketoConnectorOperator Source #
Constructors
| MarketoConnectorOperator' | |
Fields | |
Bundled Patterns
Instances
OperatorPropertiesKeys
newtype OperatorPropertiesKeys Source #
Constructors
| OperatorPropertiesKeys' | |
Fields | |
Bundled Patterns
Instances
PartyType
Constructors
| PartyType' | |
Fields | |
Bundled Patterns
| pattern PartyType_BUSINESS :: PartyType | |
| pattern PartyType_INDIVIDUAL :: PartyType | |
| pattern PartyType_OTHER :: PartyType |
Instances
S3ConnectorOperator
newtype S3ConnectorOperator Source #
Constructors
| S3ConnectorOperator' | |
Fields | |
Bundled Patterns
Instances
SalesforceConnectorOperator
newtype SalesforceConnectorOperator Source #
Constructors
| SalesforceConnectorOperator' | |
Fields | |
Bundled Patterns
Instances
ServiceNowConnectorOperator
newtype ServiceNowConnectorOperator Source #
Constructors
| ServiceNowConnectorOperator' | |
Fields | |
Bundled Patterns
Instances
SourceConnectorType
newtype SourceConnectorType Source #
Constructors
| SourceConnectorType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| StandardIdentifier' | |
Fields | |
Bundled Patterns
| pattern StandardIdentifier_ASSET :: StandardIdentifier | |
| pattern StandardIdentifier_CASE :: StandardIdentifier | |
| pattern StandardIdentifier_LOOKUP_ONLY :: StandardIdentifier | |
| pattern StandardIdentifier_NEW_ONLY :: StandardIdentifier | |
| pattern StandardIdentifier_PROFILE :: StandardIdentifier | |
| pattern StandardIdentifier_SECONDARY :: StandardIdentifier | |
| pattern StandardIdentifier_UNIQUE :: StandardIdentifier |
Instances
TaskType
Constructors
| TaskType' | |
Fields
| |
Bundled Patterns
| 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 #
Constructors
| TriggerType' | |
Fields | |
Bundled Patterns
| pattern TriggerType_Event :: TriggerType | |
| pattern TriggerType_OnDemand :: TriggerType | |
| pattern TriggerType_Scheduled :: TriggerType |
Instances
ZendeskConnectorOperator
newtype ZendeskConnectorOperator Source #
Constructors
| ZendeskConnectorOperator' | |
Fields | |
Bundled Patterns
Instances
Address
A generic address associated with the customer that is not mailing, shipping, or billing.
See: newAddress smart constructor.
Constructors
| Address' | |
Fields
| |
Instances
newAddress :: Address Source #
Create a value of Address with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address2:Address', address_address2 - The second line of a customer address.
$sel:state:Address', address_state - The state in which a customer lives.
$sel:address4:Address', address_address4 - The fourth line of a customer address.
$sel:county:Address', address_county - The county in which a customer lives.
$sel:address3:Address', address_address3 - The third line of a customer address.
$sel:postalCode:Address', address_postalCode - The postal code of a customer address.
$sel:country:Address', address_country - The country in which a customer lives.
$sel:city:Address', address_city - The city in which a customer lives.
$sel:address1:Address', address_address1 - The first line of a customer address.
$sel:province:Address', address_province - The province in which a customer lives.
ConnectorOperator
data ConnectorOperator Source #
The operation to be performed on the provided source fields.
See: newConnectorOperator smart constructor.
Constructors
| ConnectorOperator' | |
Fields
| |
Instances
newConnectorOperator :: ConnectorOperator Source #
Create a value of ConnectorOperator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceNow:ConnectorOperator', connectorOperator_serviceNow - The operation to be performed on the provided ServiceNow source fields.
$sel:marketo:ConnectorOperator', connectorOperator_marketo - The operation to be performed on the provided Marketo source fields.
$sel:salesforce:ConnectorOperator', connectorOperator_salesforce - The operation to be performed on the provided Salesforce source fields.
$sel:zendesk:ConnectorOperator', connectorOperator_zendesk - The operation to be performed on the provided Zendesk source fields.
$sel:s3:ConnectorOperator', connectorOperator_s3 - The operation to be performed on the provided Amazon S3 source fields.
connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator) Source #
The operation to be performed on the provided ServiceNow source fields.
connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator) Source #
The operation to be performed on the provided Marketo source fields.
connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator) Source #
The operation to be performed on the provided Salesforce source fields.
connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator) Source #
The operation to be performed on the provided Zendesk source fields.
connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator) Source #
The operation to be performed on the provided Amazon S3 source fields.
DomainStats
data DomainStats Source #
Usage-specific statistics about the domain.
See: newDomainStats smart constructor.
Constructors
| DomainStats' | |
Fields
| |
Instances
newDomainStats :: DomainStats Source #
Create a value of DomainStats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:meteringProfileCount:DomainStats', domainStats_meteringProfileCount - The number of profiles that you are currently paying for in the domain.
If you have more than 100 objects associated with a single profile, that
profile counts as two profiles. If you have more than 200 objects, that
profile counts as three, and so on.
$sel:totalSize:DomainStats', domainStats_totalSize - The total size, in bytes, of all objects in the domain.
$sel:profileCount:DomainStats', domainStats_profileCount - The total number of profiles currently in the domain.
$sel:objectCount:DomainStats', domainStats_objectCount - The total number of objects in domain.
domainStats_meteringProfileCount :: Lens' DomainStats (Maybe Integer) Source #
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
domainStats_totalSize :: Lens' DomainStats (Maybe Integer) Source #
The total size, in bytes, of all objects in the domain.
domainStats_profileCount :: Lens' DomainStats (Maybe Integer) Source #
The total number of profiles currently in the domain.
domainStats_objectCount :: Lens' DomainStats (Maybe Integer) Source #
The total number of objects in domain.
FieldSourceProfileIds
data FieldSourceProfileIds Source #
A duplicate customer profile that is to be merged into a main profile.
See: newFieldSourceProfileIds smart constructor.
Constructors
| FieldSourceProfileIds' | |
Fields
| |
Instances
newFieldSourceProfileIds :: FieldSourceProfileIds Source #
Create a value of FieldSourceProfileIds with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:FieldSourceProfileIds', fieldSourceProfileIds_shippingAddress - A unique identifier for the shipping address field to be merged.
$sel:mobilePhoneNumber:FieldSourceProfileIds', fieldSourceProfileIds_mobilePhoneNumber - A unique identifier for the mobile phone number field to be merged.
$sel:mailingAddress:FieldSourceProfileIds', fieldSourceProfileIds_mailingAddress - A unique identifier for the mailing address field to be merged.
$sel:middleName:FieldSourceProfileIds', fieldSourceProfileIds_middleName - A unique identifier for the middle name field to be merged.
$sel:personalEmailAddress:FieldSourceProfileIds', fieldSourceProfileIds_personalEmailAddress - A unique identifier for the personal email address field to be merged.
$sel:lastName:FieldSourceProfileIds', fieldSourceProfileIds_lastName - A unique identifier for the last name field to be merged.
$sel:additionalInformation:FieldSourceProfileIds', fieldSourceProfileIds_additionalInformation - A unique identifier for the additional information field to be merged.
$sel:homePhoneNumber:FieldSourceProfileIds', fieldSourceProfileIds_homePhoneNumber - A unique identifier for the home phone number field to be merged.
$sel:address:FieldSourceProfileIds', fieldSourceProfileIds_address - A unique identifier for the party type field to be merged.
$sel:partyType:FieldSourceProfileIds', fieldSourceProfileIds_partyType - A unique identifier for the party type field to be merged.
$sel:businessEmailAddress:FieldSourceProfileIds', fieldSourceProfileIds_businessEmailAddress - A unique identifier for the party type field to be merged.
$sel:attributes:FieldSourceProfileIds', fieldSourceProfileIds_attributes - A unique identifier for the attributes field to be merged.
$sel:gender:FieldSourceProfileIds', fieldSourceProfileIds_gender - A unique identifier for the gender field to be merged.
$sel:phoneNumber:FieldSourceProfileIds', fieldSourceProfileIds_phoneNumber - A unique identifier for the phone number field to be merged.
$sel:accountNumber:FieldSourceProfileIds', fieldSourceProfileIds_accountNumber - A unique identifier for the account number field to be merged.
$sel:emailAddress:FieldSourceProfileIds', fieldSourceProfileIds_emailAddress - A unique identifier for the email address field to be merged.
$sel:firstName:FieldSourceProfileIds', fieldSourceProfileIds_firstName - A unique identifier for the first name field to be merged.
$sel:billingAddress:FieldSourceProfileIds', fieldSourceProfileIds_billingAddress - A unique identifier for the billing type field to be merged.
$sel:businessPhoneNumber:FieldSourceProfileIds', fieldSourceProfileIds_businessPhoneNumber - A unique identifier for the business phone number field to be merged.
$sel:birthDate:FieldSourceProfileIds', fieldSourceProfileIds_birthDate - A unique identifier for the birthdate field to be merged.
$sel:businessName:FieldSourceProfileIds', fieldSourceProfileIds_businessName - A unique identifier for the business name field to be merged.
fieldSourceProfileIds_shippingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the shipping address field to be merged.
fieldSourceProfileIds_mobilePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the mobile phone number field to be merged.
fieldSourceProfileIds_mailingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the mailing address field to be merged.
fieldSourceProfileIds_middleName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the middle name field to be merged.
fieldSourceProfileIds_personalEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the personal email address field to be merged.
fieldSourceProfileIds_lastName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the last name field to be merged.
fieldSourceProfileIds_additionalInformation :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the additional information field to be merged.
fieldSourceProfileIds_homePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the home phone number field to be merged.
fieldSourceProfileIds_address :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_partyType :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_businessEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the party type field to be merged.
fieldSourceProfileIds_attributes :: Lens' FieldSourceProfileIds (Maybe (HashMap Text Text)) Source #
A unique identifier for the attributes field to be merged.
fieldSourceProfileIds_gender :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the gender field to be merged.
fieldSourceProfileIds_phoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the phone number field to be merged.
fieldSourceProfileIds_accountNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the account number field to be merged.
fieldSourceProfileIds_emailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the email address field to be merged.
fieldSourceProfileIds_firstName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the first name field to be merged.
fieldSourceProfileIds_billingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the billing type field to be merged.
fieldSourceProfileIds_businessPhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the business phone number field to be merged.
fieldSourceProfileIds_birthDate :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the birthdate field to be merged.
fieldSourceProfileIds_businessName :: Lens' FieldSourceProfileIds (Maybe Text) Source #
A unique identifier for the business name field to be merged.
FlowDefinition
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.
Constructors
| FlowDefinition' | |
Fields
| |
Instances
Arguments
| :: 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.
flowDefinition_description :: Lens' FlowDefinition (Maybe Text) Source #
A description of the flow you want to create.
flowDefinition_flowName :: Lens' FlowDefinition Text Source #
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
flowDefinition_kmsArn :: Lens' FlowDefinition Text Source #
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig Source #
The configuration that controls how Customer Profiles retrieves data from the source.
flowDefinition_tasks :: Lens' FlowDefinition [Task] Source #
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig Source #
The trigger settings that determine how and when the flow runs.
IncrementalPullConfig
data IncrementalPullConfig Source #
Specifies the configuration used when importing incremental records from the source.
See: newIncrementalPullConfig smart constructor.
Constructors
| IncrementalPullConfig' | |
Fields
| |
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.
incrementalPullConfig_datetimeTypeFieldName :: Lens' IncrementalPullConfig (Maybe Text) Source #
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
ListDomainItem
data ListDomainItem Source #
An object in a list that represents a domain.
See: newListDomainItem smart constructor.
Constructors
| ListDomainItem' | |
Fields | |
Instances
Arguments
| :: 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.
listDomainItem_tags :: Lens' ListDomainItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listDomainItem_domainName :: Lens' ListDomainItem Text Source #
The unique name of the domain.
listDomainItem_createdAt :: Lens' ListDomainItem UTCTime Source #
The timestamp of when the domain was created.
listDomainItem_lastUpdatedAt :: Lens' ListDomainItem UTCTime Source #
The timestamp of when the domain was most recently edited.
ListIntegrationItem
data ListIntegrationItem Source #
An integration in list of integrations.
See: newListIntegrationItem smart constructor.
Constructors
| ListIntegrationItem' | |
Fields
| |
Instances
newListIntegrationItem Source #
Create a value of ListIntegrationItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListIntegrationItem', listIntegrationItem_tags - The tags used to organize, track, or control access for this resource.
$sel:domainName:ListIntegrationItem', listIntegrationItem_domainName - The unique name of the domain.
$sel:uri:ListIntegrationItem', listIntegrationItem_uri - The URI of the S3 bucket or any other type of data source.
$sel:objectTypeName:ListIntegrationItem', listIntegrationItem_objectTypeName - The name of the profile object type.
$sel:createdAt:ListIntegrationItem', listIntegrationItem_createdAt - The timestamp of when the domain was created.
$sel:lastUpdatedAt:ListIntegrationItem', listIntegrationItem_lastUpdatedAt - The timestamp of when the domain was most recently edited.
listIntegrationItem_tags :: Lens' ListIntegrationItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listIntegrationItem_domainName :: Lens' ListIntegrationItem Text Source #
The unique name of the domain.
listIntegrationItem_uri :: Lens' ListIntegrationItem Text Source #
The URI of the S3 bucket or any other type of data source.
listIntegrationItem_objectTypeName :: Lens' ListIntegrationItem Text Source #
The name of the profile object type.
listIntegrationItem_createdAt :: Lens' ListIntegrationItem UTCTime Source #
The timestamp of when the domain was created.
listIntegrationItem_lastUpdatedAt :: Lens' ListIntegrationItem UTCTime Source #
The timestamp of when the domain was most recently edited.
ListProfileObjectTypeItem
data ListProfileObjectTypeItem Source #
A ProfileObjectType instance.
See: newListProfileObjectTypeItem smart constructor.
Constructors
| ListProfileObjectTypeItem' | |
Fields
| |
Instances
newListProfileObjectTypeItem Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListProfileObjectTypeItem |
Create a value of ListProfileObjectTypeItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedAt:ListProfileObjectTypeItem', listProfileObjectTypeItem_lastUpdatedAt - The timestamp of when the domain was most recently edited.
$sel:createdAt:ListProfileObjectTypeItem', listProfileObjectTypeItem_createdAt - The timestamp of when the domain was created.
$sel:tags:ListProfileObjectTypeItem', listProfileObjectTypeItem_tags - The tags used to organize, track, or control access for this resource.
$sel:objectTypeName:ListProfileObjectTypeItem', listProfileObjectTypeItem_objectTypeName - The name of the profile object type.
$sel:description:ListProfileObjectTypeItem', listProfileObjectTypeItem_description - Description of the profile object type.
listProfileObjectTypeItem_lastUpdatedAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #
The timestamp of when the domain was most recently edited.
listProfileObjectTypeItem_createdAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #
The timestamp of when the domain was created.
listProfileObjectTypeItem_tags :: Lens' ListProfileObjectTypeItem (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
listProfileObjectTypeItem_objectTypeName :: Lens' ListProfileObjectTypeItem Text Source #
The name of the profile object type.
listProfileObjectTypeItem_description :: Lens' ListProfileObjectTypeItem Text Source #
Description of the profile object type.
ListProfileObjectTypeTemplateItem
data ListProfileObjectTypeTemplateItem Source #
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
See: newListProfileObjectTypeTemplateItem smart constructor.
Constructors
| ListProfileObjectTypeTemplateItem' | |
Fields
| |
Instances
newListProfileObjectTypeTemplateItem :: ListProfileObjectTypeTemplateItem Source #
Create a value of ListProfileObjectTypeTemplateItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceName:ListProfileObjectTypeTemplateItem', listProfileObjectTypeTemplateItem_sourceName - The name of the source of the object template.
$sel:templateId:ListProfileObjectTypeTemplateItem', listProfileObjectTypeTemplateItem_templateId - A unique identifier for the object template.
$sel:sourceObject:ListProfileObjectTypeTemplateItem', listProfileObjectTypeTemplateItem_sourceObject - The source of the object template.
listProfileObjectTypeTemplateItem_sourceName :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
The name of the source of the object template.
listProfileObjectTypeTemplateItem_templateId :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
A unique identifier for the object template.
listProfileObjectTypeTemplateItem_sourceObject :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #
The source of the object template.
ListProfileObjectsItem
data ListProfileObjectsItem Source #
A ProfileObject in a list of ProfileObjects.
See: newListProfileObjectsItem smart constructor.
Constructors
| ListProfileObjectsItem' | |
Fields
| |
Instances
newListProfileObjectsItem :: ListProfileObjectsItem Source #
Create a value of ListProfileObjectsItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileObjectUniqueKey:ListProfileObjectsItem', listProfileObjectsItem_profileObjectUniqueKey - The unique identifier of the ProfileObject generated by the service.
$sel:objectTypeName:ListProfileObjectsItem', listProfileObjectsItem_objectTypeName - Specifies the kind of object being added to a profile, such as
"Salesforce-Account."
$sel:object':ListProfileObjectsItem', listProfileObjectsItem_object - A JSON representation of a ProfileObject that belongs to a profile.
listProfileObjectsItem_profileObjectUniqueKey :: Lens' ListProfileObjectsItem (Maybe Text) Source #
The unique identifier of the ProfileObject generated by the service.
listProfileObjectsItem_objectTypeName :: Lens' ListProfileObjectsItem (Maybe Text) Source #
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
listProfileObjectsItem_object :: Lens' ListProfileObjectsItem (Maybe Text) Source #
A JSON representation of a ProfileObject that belongs to a profile.
MarketoSourceProperties
data MarketoSourceProperties Source #
The properties that are applied when Marketo is being used as a source.
See: newMarketoSourceProperties smart constructor.
Constructors
| MarketoSourceProperties' | |
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.
marketoSourceProperties_object :: Lens' MarketoSourceProperties Text Source #
The object specified in the Marketo flow source.
MatchItem
The Match group object.
See: newMatchItem smart constructor.
Constructors
| MatchItem' | |
Instances
| Eq MatchItem Source # | |
| Read MatchItem Source # | |
| Show MatchItem Source # | |
| Generic MatchItem Source # | |
| NFData MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
| Hashable MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem | |
| FromJSON MatchItem Source # | |
| type Rep MatchItem Source # | |
Defined in Amazonka.CustomerProfiles.Types.MatchItem type Rep MatchItem = D1 ('MetaData "MatchItem" "Amazonka.CustomerProfiles.Types.MatchItem" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "MatchItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "profileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "matchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newMatchItem :: MatchItem Source #
Create a value of MatchItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileIds:MatchItem', matchItem_profileIds - A list of identifiers for profiles that match.
$sel:matchId:MatchItem', matchItem_matchId - The unique identifiers for this group of profiles that match.
matchItem_profileIds :: Lens' MatchItem (Maybe [Text]) Source #
A list of identifiers for profiles that match.
matchItem_matchId :: Lens' MatchItem (Maybe Text) Source #
The unique identifiers for this group of profiles that match.
MatchingRequest
data MatchingRequest Source #
The flag that enables the matching process of duplicate profiles.
See: newMatchingRequest smart constructor.
Constructors
| MatchingRequest' | |
Instances
Arguments
| :: Bool | |
| -> MatchingRequest |
Create a value of MatchingRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:MatchingRequest', matchingRequest_enabled - The flag that enables the matching process of duplicate profiles.
matchingRequest_enabled :: Lens' MatchingRequest Bool Source #
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.
Constructors
| MatchingResponse' | |
Instances
newMatchingResponse :: MatchingResponse Source #
Create a value of MatchingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:MatchingResponse', matchingResponse_enabled - The flag that enables the matching process of duplicate profiles.
matchingResponse_enabled :: Lens' MatchingResponse (Maybe Bool) Source #
The flag that enables the matching process of duplicate profiles.
ObjectFilter
data ObjectFilter Source #
The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset and _case.
See: newObjectFilter smart constructor.
Constructors
| ObjectFilter' | |
Instances
Arguments
| :: Text | |
| -> ObjectFilter |
Create a value of ObjectFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyName:ObjectFilter', objectFilter_keyName - A searchable identifier of a standard profile object. The predefined
keys you can use to search for _asset include: _assetId, _assetName,
_serialNumber. The predefined keys you can use to search for _case
include: _caseId.
$sel:values:ObjectFilter', objectFilter_values - A list of key values.
objectFilter_keyName :: Lens' ObjectFilter Text Source #
A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId.
objectFilter_values :: Lens' ObjectFilter [Text] Source #
A list of key values.
ObjectTypeField
data ObjectTypeField Source #
Represents a field in a ProfileObjectType.
See: newObjectTypeField smart constructor.
Constructors
| ObjectTypeField' | |
Fields
| |
Instances
newObjectTypeField :: ObjectTypeField Source #
Create a value of ObjectTypeField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:source:ObjectTypeField', objectTypeField_source - A field of a ProfileObject. For example: _source.FirstName, where
“_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a
field in that ObjectType.
$sel:contentType:ObjectTypeField', objectTypeField_contentType - The content type of the field. Used for determining equality when
searching.
$sel:target:ObjectTypeField', objectTypeField_target - The location of the data in the standard ProfileObject model. For
example: _profile.Address.PostalCode.
objectTypeField_source :: Lens' ObjectTypeField (Maybe Text) Source #
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
objectTypeField_contentType :: Lens' ObjectTypeField (Maybe FieldContentType) Source #
The content type of the field. Used for determining equality when searching.
objectTypeField_target :: Lens' ObjectTypeField (Maybe Text) Source #
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ObjectTypeKey
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.
Constructors
| ObjectTypeKey' | |
Fields
| |
Instances
newObjectTypeKey :: ObjectTypeKey Source #
Create a value of ObjectTypeKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldNames:ObjectTypeKey', objectTypeKey_fieldNames - The reference for the key name of the fields map.
$sel:standardIdentifiers:ObjectTypeKey', objectTypeKey_standardIdentifiers - The types of keys that a ProfileObject can have. Each ProfileObject can
have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE
means that this key can be used to tie an object to a PROFILE, ASSET or
CASE respectively. UNIQUE means that it can be used to uniquely identify
an object. If a key a is marked as SECONDARY, it will be used to search
for profiles after all other PROFILE keys have been searched. A
LOOKUP_ONLY key is only used to match a profile but is not persisted to
be used for searching of the profile. A NEW_ONLY key is only used if the
profile does not already exist before the object is ingested, otherwise
it is only used for matching objects to profiles.
objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text]) Source #
The reference for the key name of the fields map.
objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier]) Source #
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
Profile
The standard profile of a customer.
See: newProfile smart constructor.
Constructors
| Profile' | |
Fields
| |
Instances
newProfile :: Profile Source #
Create a value of Profile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingAddress:Profile', profile_shippingAddress - The customer’s shipping address.
$sel:mobilePhoneNumber:Profile', profile_mobilePhoneNumber - The customer’s mobile phone number.
$sel:mailingAddress:Profile', profile_mailingAddress - The customer’s mailing address.
$sel:middleName:Profile', profile_middleName - The customer’s middle name.
$sel:personalEmailAddress:Profile', profile_personalEmailAddress - The customer’s personal email address.
$sel:lastName:Profile', profile_lastName - The customer’s last name.
$sel:additionalInformation:Profile', profile_additionalInformation - Any additional information relevant to the customer’s profile.
$sel:homePhoneNumber:Profile', profile_homePhoneNumber - The customer’s home phone number.
$sel:address:Profile', profile_address - A generic address associated with the customer that is not mailing,
shipping, or billing.
$sel:partyType:Profile', profile_partyType - The type of profile used to describe the customer.
$sel:profileId:Profile', profile_profileId - The unique identifier of a customer profile.
$sel:businessEmailAddress:Profile', profile_businessEmailAddress - The customer’s business email address.
$sel:attributes:Profile', profile_attributes - A key value pair of attributes of a customer profile.
$sel:gender:Profile', profile_gender - The gender with which the customer identifies.
$sel:phoneNumber:Profile', profile_phoneNumber - The customer's phone number, which has not been specified as a mobile,
home, or business number.
$sel:accountNumber:Profile', profile_accountNumber - A unique account number that you have given to the customer.
$sel:emailAddress:Profile', profile_emailAddress - The customer’s email address, which has not been specified as a personal
or business address.
$sel:firstName:Profile', profile_firstName - The customer’s first name.
$sel:billingAddress:Profile', profile_billingAddress - The customer’s billing address.
$sel:businessPhoneNumber:Profile', profile_businessPhoneNumber - The customer’s home phone number.
$sel:birthDate:Profile', profile_birthDate - The customer’s birth date.
$sel:businessName:Profile', profile_businessName - The name of the customer’s business.
profile_personalEmailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s personal email address.
profile_additionalInformation :: Lens' Profile (Maybe Text) Source #
Any additional information relevant to the customer’s profile.
profile_address :: Lens' Profile (Maybe Address) Source #
A generic address associated with the customer that is not mailing, shipping, or billing.
profile_partyType :: Lens' Profile (Maybe PartyType) Source #
The type of profile used to describe the customer.
profile_profileId :: Lens' Profile (Maybe Text) Source #
The unique identifier of a customer profile.
profile_businessEmailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s business email address.
profile_attributes :: Lens' Profile (Maybe (HashMap Text Text)) Source #
A key value pair of attributes of a customer profile.
profile_gender :: Lens' Profile (Maybe Gender) Source #
The gender with which the customer identifies.
profile_phoneNumber :: Lens' Profile (Maybe Text) Source #
The customer's phone number, which has not been specified as a mobile, home, or business number.
profile_accountNumber :: Lens' Profile (Maybe Text) Source #
A unique account number that you have given to the customer.
profile_emailAddress :: Lens' Profile (Maybe Text) Source #
The customer’s email address, which has not been specified as a personal or business address.
S3SourceProperties
data S3SourceProperties Source #
The properties that are applied when Amazon S3 is being used as the flow source.
See: newS3SourceProperties smart constructor.
Constructors
| S3SourceProperties' | |
Fields
| |
Instances
newS3SourceProperties Source #
Arguments
| :: Text | |
| -> S3SourceProperties |
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.
s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text) Source #
The object key for the Amazon S3 bucket in which the source files are stored.
s3SourceProperties_bucketName :: Lens' S3SourceProperties Text Source #
The Amazon S3 bucket name where the source files are stored.
SalesforceSourceProperties
data SalesforceSourceProperties Source #
The properties that are applied when Salesforce is being used as a source.
See: newSalesforceSourceProperties smart constructor.
Constructors
| SalesforceSourceProperties' | |
Fields
| |
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.
salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool) Source #
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool) Source #
Indicates whether Amazon AppFlow includes deleted files in the flow run.
salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text Source #
The object specified in the Salesforce flow source.
ScheduledTriggerProperties
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.
Constructors
| ScheduledTriggerProperties' | |
Fields
| |
Instances
newScheduledTriggerProperties Source #
Create a value of ScheduledTriggerProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleEndTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleEndTime - Specifies the scheduled end time for a scheduled-trigger flow.
$sel:scheduleOffset:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleOffset - Specifies the optional offset that is added to the time interval for a
schedule-triggered flow.
$sel:dataPullMode:ScheduledTriggerProperties', scheduledTriggerProperties_dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a
complete data transfer for each flow run.
$sel:scheduleStartTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleStartTime - Specifies the scheduled start time for a scheduled-trigger flow.
$sel:timezone:ScheduledTriggerProperties', scheduledTriggerProperties_timezone - Specifies the time zone used when referring to the date and time of a
scheduled-triggered flow, such as America/New_York.
$sel:firstExecutionFrom:ScheduledTriggerProperties', scheduledTriggerProperties_firstExecutionFrom - Specifies the date range for the records to import from the connector in
the first flow run.
$sel:scheduleExpression:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleExpression - The scheduling expression that determines the rate at which the schedule
will run, for example rate (5 minutes).
scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the scheduled end time for a scheduled-trigger flow.
scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural) Source #
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode) Source #
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the scheduled start time for a scheduled-trigger flow.
scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text) Source #
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #
Specifies the date range for the records to import from the connector in the first flow run.
scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text Source #
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
ServiceNowSourceProperties
data ServiceNowSourceProperties Source #
The properties that are applied when ServiceNow is being used as a source.
See: newServiceNowSourceProperties smart constructor.
Constructors
| ServiceNowSourceProperties' | |
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.
serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text Source #
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.
Constructors
| SourceConnectorProperties' | |
Fields
| |
Instances
newSourceConnectorProperties :: SourceConnectorProperties Source #
Create a value of SourceConnectorProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceNow:SourceConnectorProperties', sourceConnectorProperties_serviceNow - The properties that are applied when ServiceNow is being used as a
source.
$sel:marketo:SourceConnectorProperties', sourceConnectorProperties_marketo - The properties that are applied when Marketo is being used as a source.
$sel:salesforce:SourceConnectorProperties', sourceConnectorProperties_salesforce - The properties that are applied when Salesforce is being used as a
source.
$sel:zendesk:SourceConnectorProperties', sourceConnectorProperties_zendesk - The properties that are applied when using Zendesk as a flow source.
$sel:s3:SourceConnectorProperties', sourceConnectorProperties_s3 - The properties that are applied when Amazon S3 is being used as the flow
source.
sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties) Source #
The properties that are applied when ServiceNow is being used as a source.
sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties) Source #
The properties that are applied when Marketo is being used as a source.
sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties) Source #
The properties that are applied when Salesforce is being used as a source.
sourceConnectorProperties_zendesk :: Lens' SourceConnectorProperties (Maybe ZendeskSourceProperties) Source #
The properties that are applied when using Zendesk as a flow source.
sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties) Source #
The properties that are applied when Amazon S3 is being used as the flow source.
SourceFlowConfig
data SourceFlowConfig Source #
Contains information about the configuration of the source connector used in the flow.
See: newSourceFlowConfig smart constructor.
Constructors
| SourceFlowConfig' | |
Fields
| |
Instances
Arguments
| :: SourceConnectorType | |
| -> SourceConnectorProperties | |
| -> SourceFlowConfig |
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.
sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text) Source #
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig) Source #
Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
sourceFlowConfig_connectorType :: Lens' SourceFlowConfig SourceConnectorType Source #
The type of connector, such as Salesforce, Marketo, and so on.
sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties Source #
Specifies the information that is required to query a particular source connector.
Task
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
See: newTask smart constructor.
Constructors
| Task' | |
Fields
| |
Instances
Create a value of Task with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:taskProperties:Task', task_taskProperties - A map used to store task-related information. The service looks for
particular information based on the TaskType.
$sel:connectorOperator:Task', task_connectorOperator - The operation to be performed on the provided source fields.
$sel:destinationField:Task', task_destinationField - A field in a destination connector, or a field value against which
Amazon AppFlow validates a source field.
$sel:sourceFields:Task', task_sourceFields - The source fields to which a particular task is applied.
$sel:taskType:Task', task_taskType - Specifies the particular task implementation that Amazon AppFlow
performs.
task_taskProperties :: Lens' Task (Maybe (HashMap OperatorPropertiesKeys Text)) Source #
A map used to store task-related information. The service looks for particular information based on the TaskType.
task_connectorOperator :: Lens' Task (Maybe ConnectorOperator) Source #
The operation to be performed on the provided source fields.
task_destinationField :: Lens' Task (Maybe Text) Source #
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
task_sourceFields :: Lens' Task [Text] Source #
The source fields to which a particular task is applied.
task_taskType :: Lens' Task TaskType Source #
Specifies the particular task implementation that Amazon AppFlow performs.
TriggerConfig
data TriggerConfig Source #
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
See: newTriggerConfig smart constructor.
Constructors
| TriggerConfig' | |
Fields
| |
Instances
Arguments
| :: TriggerType | |
| -> TriggerConfig |
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.
triggerConfig_triggerProperties :: Lens' TriggerConfig (Maybe TriggerProperties) Source #
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
triggerConfig_triggerType :: Lens' TriggerConfig TriggerType Source #
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
TriggerProperties
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.
Constructors
| TriggerProperties' | |
Fields
| |
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.
triggerProperties_scheduled :: Lens' TriggerProperties (Maybe ScheduledTriggerProperties) Source #
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.
Constructors
| UpdateAddress' | |
Fields
| |
Instances
newUpdateAddress :: UpdateAddress Source #
Create a value of UpdateAddress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address2:UpdateAddress', updateAddress_address2 - The second line of a customer address.
$sel:state:UpdateAddress', updateAddress_state - The state in which a customer lives.
$sel:address4:UpdateAddress', updateAddress_address4 - The fourth line of a customer address.
$sel:county:UpdateAddress', updateAddress_county - The county in which a customer lives.
$sel:address3:UpdateAddress', updateAddress_address3 - The third line of a customer address.
$sel:postalCode:UpdateAddress', updateAddress_postalCode - The postal code of a customer address.
$sel:country:UpdateAddress', updateAddress_country - The country in which a customer lives.
$sel:city:UpdateAddress', updateAddress_city - The city in which a customer lives.
$sel:address1:UpdateAddress', updateAddress_address1 - The first line of a customer address.
$sel:province:UpdateAddress', updateAddress_province - The province in which a customer lives.
updateAddress_address2 :: Lens' UpdateAddress (Maybe Text) Source #
The second line of a customer address.
updateAddress_state :: Lens' UpdateAddress (Maybe Text) Source #
The state in which a customer lives.
updateAddress_address4 :: Lens' UpdateAddress (Maybe Text) Source #
The fourth line of a customer address.
updateAddress_county :: Lens' UpdateAddress (Maybe Text) Source #
The county in which a customer lives.
updateAddress_address3 :: Lens' UpdateAddress (Maybe Text) Source #
The third line of a customer address.
updateAddress_postalCode :: Lens' UpdateAddress (Maybe Text) Source #
The postal code of a customer address.
updateAddress_country :: Lens' UpdateAddress (Maybe Text) Source #
The country in which a customer lives.
updateAddress_city :: Lens' UpdateAddress (Maybe Text) Source #
The city in which a customer lives.
updateAddress_address1 :: Lens' UpdateAddress (Maybe Text) Source #
The first line of a customer address.
updateAddress_province :: Lens' UpdateAddress (Maybe Text) Source #
The province in which a customer lives.
ZendeskSourceProperties
data ZendeskSourceProperties Source #
The properties that are applied when using Zendesk as a flow source.
See: newZendeskSourceProperties smart constructor.
Constructors
| ZendeskSourceProperties' | |
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.
zendeskSourceProperties_object :: Lens' ZendeskSourceProperties Text Source #
The object specified in the Zendesk flow source.