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

Amazonka.CustomerProfiles.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AddProfileKey

addProfileKey_profileId :: Lens' AddProfileKey Text Source #

The unique identifier of a customer profile.

addProfileKey_keyName :: Lens' AddProfileKey Text Source #

A searchable identifier of a customer profile. 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_values :: Lens' AddProfileKey [Text] Source #

A list of key values.

addProfileKey_domainName :: Lens' AddProfileKey Text Source #

The unique name of the domain.

addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text) Source #

A searchable identifier of a customer profile.

addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text]) Source #

A list of key values.

addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int Source #

The response's http status code.

CreateDomain

createDomain_deadLetterQueueUrl :: Lens' CreateDomain (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

createDomain_defaultEncryptionKey :: Lens' CreateDomain (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

createDomain_matching :: Lens' CreateDomain (Maybe MatchingRequest) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process 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_tags :: Lens' CreateDomain (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createDomain_domainName :: Lens' CreateDomain Text Source #

The unique name of the domain.

createDomain_defaultExpirationDays :: Lens' CreateDomain Natural Source #

The default number of days until the data within the domain expires.

createDomainResponse_deadLetterQueueUrl :: Lens' CreateDomainResponse (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

createDomainResponse_defaultEncryptionKey :: Lens' CreateDomainResponse (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

createDomainResponse_matching :: Lens' CreateDomainResponse (Maybe MatchingResponse) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process 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.

createDomainResponse_tags :: Lens' CreateDomainResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.

createDomainResponse_domainName :: Lens' CreateDomainResponse Text Source #

The unique name of the domain.

createDomainResponse_defaultExpirationDays :: Lens' CreateDomainResponse Natural Source #

The default number of days until the data within the domain expires.

createDomainResponse_createdAt :: Lens' CreateDomainResponse UTCTime Source #

The timestamp of when the domain was created.

createDomainResponse_lastUpdatedAt :: Lens' CreateDomainResponse UTCTime Source #

The timestamp of when the domain was most recently edited.

CreateIntegrationWorkflow

createIntegrationWorkflow_tags :: Lens' CreateIntegrationWorkflow (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createIntegrationWorkflow_domainName :: Lens' CreateIntegrationWorkflow Text Source #

The unique name of the domain.

createIntegrationWorkflow_workflowType :: Lens' CreateIntegrationWorkflow WorkflowType Source #

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

createIntegrationWorkflow_integrationConfig :: Lens' CreateIntegrationWorkflow IntegrationConfig Source #

Configuration data for integration workflow.

createIntegrationWorkflow_objectTypeName :: Lens' CreateIntegrationWorkflow Text Source #

The name of the profile object type.

createIntegrationWorkflow_roleArn :: Lens' CreateIntegrationWorkflow Text Source #

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.

createIntegrationWorkflowResponse_httpStatus :: Lens' CreateIntegrationWorkflowResponse Int Source #

The response's http status code.

createIntegrationWorkflowResponse_workflowId :: Lens' CreateIntegrationWorkflowResponse Text Source #

Unique identifier for the workflow.

createIntegrationWorkflowResponse_message :: Lens' CreateIntegrationWorkflowResponse Text Source #

A message indicating create request was received.

CreateProfile

createProfile_accountNumber :: Lens' CreateProfile (Maybe Text) Source #

A unique account number that you have given to the customer.

createProfile_additionalInformation :: Lens' CreateProfile (Maybe Text) Source #

Any additional information relevant to the customer’s profile.

createProfile_address :: Lens' CreateProfile (Maybe Address) Source #

A generic address associated with the customer that is not mailing, shipping, or billing.

createProfile_attributes :: Lens' CreateProfile (Maybe (HashMap Text Text)) Source #

A key value pair of attributes of a customer profile.

createProfile_billingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s billing address.

createProfile_birthDate :: Lens' CreateProfile (Maybe Text) Source #

The customer’s birth date.

createProfile_businessEmailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s business email address.

createProfile_businessName :: Lens' CreateProfile (Maybe Text) Source #

The name of the customer’s business.

createProfile_businessPhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s business phone number.

createProfile_emailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s email address, which has not been specified as a personal or business address.

createProfile_firstName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s first name.

createProfile_gender :: Lens' CreateProfile (Maybe Gender) Source #

The gender with which the customer identifies.

createProfile_genderString :: Lens' CreateProfile (Maybe Text) Source #

An alternative to Gender which accepts any string as input.

createProfile_homePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s home phone number.

createProfile_lastName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s last name.

createProfile_mailingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s mailing address.

createProfile_middleName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s middle name.

createProfile_mobilePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s mobile phone number.

createProfile_partyType :: Lens' CreateProfile (Maybe PartyType) Source #

The type of profile used to describe the customer.

createProfile_partyTypeString :: Lens' CreateProfile (Maybe Text) Source #

An alternative to PartyType which accepts any string as input.

createProfile_personalEmailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s personal email address.

createProfile_phoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s phone number, which has not been specified as a mobile, home, or business number.

createProfile_shippingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s shipping address.

createProfile_domainName :: Lens' CreateProfile Text Source #

The unique name of the domain.

createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #

The response's http status code.

createProfileResponse_profileId :: Lens' CreateProfileResponse Text Source #

The unique identifier of a customer profile.

DeleteDomain

deleteDomain_domainName :: Lens' DeleteDomain Text Source #

The unique name of the domain.

deleteDomainResponse_httpStatus :: Lens' DeleteDomainResponse Int Source #

The response's http status code.

deleteDomainResponse_message :: Lens' DeleteDomainResponse Text Source #

A message that indicates the delete request is done.

DeleteIntegration

deleteIntegration_domainName :: Lens' DeleteIntegration Text Source #

The unique name of the domain.

deleteIntegration_uri :: Lens' DeleteIntegration Text Source #

The URI of the S3 bucket or any other type of data source.

deleteIntegrationResponse_httpStatus :: Lens' DeleteIntegrationResponse Int Source #

The response's http status code.

deleteIntegrationResponse_message :: Lens' DeleteIntegrationResponse Text Source #

A message that indicates the delete request is done.

DeleteProfile

deleteProfile_profileId :: Lens' DeleteProfile Text Source #

The unique identifier of a customer profile.

deleteProfile_domainName :: Lens' DeleteProfile Text Source #

The unique name of the domain.

deleteProfileResponse_message :: Lens' DeleteProfileResponse (Maybe Text) Source #

A message that indicates the delete request is done.

deleteProfileResponse_httpStatus :: Lens' DeleteProfileResponse Int Source #

The response's http status code.

DeleteProfileKey

deleteProfileKey_profileId :: Lens' DeleteProfileKey Text Source #

The unique identifier of a customer profile.

deleteProfileKey_keyName :: Lens' DeleteProfileKey Text Source #

A searchable identifier of a customer profile.

deleteProfileKey_values :: Lens' DeleteProfileKey [Text] Source #

A list of key values.

deleteProfileKey_domainName :: Lens' DeleteProfileKey Text Source #

The unique name of the domain.

deleteProfileKeyResponse_message :: Lens' DeleteProfileKeyResponse (Maybe Text) Source #

A message that indicates the delete request is done.

deleteProfileKeyResponse_httpStatus :: Lens' DeleteProfileKeyResponse Int Source #

The response's http status code.

DeleteProfileObject

deleteProfileObject_profileId :: Lens' DeleteProfileObject Text Source #

The unique identifier of a customer profile.

deleteProfileObject_profileObjectUniqueKey :: Lens' DeleteProfileObject Text Source #

The unique identifier of the profile object generated by the service.

deleteProfileObject_objectTypeName :: Lens' DeleteProfileObject Text Source #

The name of the profile object type.

deleteProfileObject_domainName :: Lens' DeleteProfileObject Text Source #

The unique name of the domain.

deleteProfileObjectResponse_message :: Lens' DeleteProfileObjectResponse (Maybe Text) Source #

A message that indicates the delete request is done.

deleteProfileObjectResponse_httpStatus :: Lens' DeleteProfileObjectResponse Int Source #

The response's http status code.

DeleteProfileObjectType

deleteProfileObjectType_domainName :: Lens' DeleteProfileObjectType Text Source #

The unique name of the domain.

deleteProfileObjectType_objectTypeName :: Lens' DeleteProfileObjectType Text Source #

The name of the profile object type.

deleteProfileObjectTypeResponse_httpStatus :: Lens' DeleteProfileObjectTypeResponse Int Source #

The response's http status code.

deleteProfileObjectTypeResponse_message :: Lens' DeleteProfileObjectTypeResponse Text Source #

A message that indicates the delete request is done.

DeleteWorkflow

deleteWorkflow_domainName :: Lens' DeleteWorkflow Text Source #

The unique name of the domain.

deleteWorkflow_workflowId :: Lens' DeleteWorkflow Text Source #

Unique identifier for the workflow.

deleteWorkflowResponse_httpStatus :: Lens' DeleteWorkflowResponse Int Source #

The response's http status code.

GetAutoMergingPreview

getAutoMergingPreview_minAllowedConfidenceScoreForMerging :: Lens' GetAutoMergingPreview (Maybe Double) Source #

Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

getAutoMergingPreview_domainName :: Lens' GetAutoMergingPreview Text Source #

The unique name of the domain.

getAutoMergingPreview_consolidation :: Lens' GetAutoMergingPreview Consolidation Source #

A list of matching attributes that represent matching criteria.

getAutoMergingPreview_conflictResolution :: Lens' GetAutoMergingPreview ConflictResolution Source #

How the auto-merging process should resolve conflicts between different profiles.

getAutoMergingPreviewResponse_numberOfMatchesInSample :: Lens' GetAutoMergingPreviewResponse (Maybe Integer) Source #

The number of match groups in the domain that have been reviewed in this preview dry run.

getAutoMergingPreviewResponse_numberOfProfilesInSample :: Lens' GetAutoMergingPreviewResponse (Maybe Integer) Source #

The number of profiles found in this preview dry run.

getAutoMergingPreviewResponse_numberOfProfilesWillBeMerged :: Lens' GetAutoMergingPreviewResponse (Maybe Integer) Source #

The number of profiles that would be merged if this wasn't a preview dry run.

getAutoMergingPreviewResponse_httpStatus :: Lens' GetAutoMergingPreviewResponse Int Source #

The response's http status code.

getAutoMergingPreviewResponse_domainName :: Lens' GetAutoMergingPreviewResponse Text Source #

The unique name of the domain.

GetDomain

getDomain_domainName :: Lens' GetDomain Text Source #

The unique name of the domain.

getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural) Source #

The default number of days until the data within the domain expires.

getDomainResponse_matching :: Lens' GetDomainResponse (Maybe MatchingResponse) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process 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.

getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats) Source #

Usage-specific statistics about the domain.

getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #

The response's http status code.

getDomainResponse_domainName :: Lens' GetDomainResponse Text Source #

The unique name of the domain.

getDomainResponse_createdAt :: Lens' GetDomainResponse UTCTime Source #

The timestamp of when the domain was created.

getDomainResponse_lastUpdatedAt :: Lens' GetDomainResponse UTCTime Source #

The timestamp of when the domain was most recently edited.

GetIdentityResolutionJob

getIdentityResolutionJob_domainName :: Lens' GetIdentityResolutionJob Text Source #

The unique name of the domain.

getIdentityResolutionJob_jobId :: Lens' GetIdentityResolutionJob Text Source #

The unique identifier of the Identity Resolution Job.

getIdentityResolutionJobResponse_autoMerging :: Lens' GetIdentityResolutionJobResponse (Maybe AutoMerging) Source #

Configuration settings for how to perform the auto-merging of profiles.

getIdentityResolutionJobResponse_domainName :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #

The unique name of the domain.

getIdentityResolutionJobResponse_exportingLocation :: Lens' GetIdentityResolutionJobResponse (Maybe ExportingLocation) Source #

The S3 location where the Identity Resolution Job writes result files.

getIdentityResolutionJobResponse_jobEndTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #

The timestamp of when the Identity Resolution Job was completed.

getIdentityResolutionJobResponse_jobExpirationTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #

The timestamp of when the Identity Resolution Job will expire.

getIdentityResolutionJobResponse_jobId :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #

The unique identifier of the Identity Resolution Job.

getIdentityResolutionJobResponse_jobStartTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #

The timestamp of when the Identity Resolution Job was started or will be started.

getIdentityResolutionJobResponse_jobStats :: Lens' GetIdentityResolutionJobResponse (Maybe JobStats) Source #

Statistics about the Identity Resolution Job.

getIdentityResolutionJobResponse_lastUpdatedAt :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #

The timestamp of when the Identity Resolution Job was most recently edited.

getIdentityResolutionJobResponse_message :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #

The error messages that are generated when the Identity Resolution Job runs.

getIdentityResolutionJobResponse_status :: Lens' GetIdentityResolutionJobResponse (Maybe IdentityResolutionJobStatus) Source #

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 the PENDING 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.

getIdentityResolutionJobResponse_httpStatus :: Lens' GetIdentityResolutionJobResponse Int Source #

The response's http status code.

GetIntegration

getIntegration_domainName :: Lens' GetIntegration Text Source #

The unique name of the domain.

getIntegration_uri :: Lens' GetIntegration Text Source #

The URI of the S3 bucket or any other type of data source.

getIntegrationResponse_isUnstructured :: Lens' GetIntegrationResponse (Maybe Bool) Source #

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_objectTypeName :: Lens' GetIntegrationResponse (Maybe Text) Source #

The name of the profile object type.

getIntegrationResponse_objectTypeNames :: Lens' GetIntegrationResponse (Maybe (HashMap Text Text)) Source #

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_tags :: Lens' GetIntegrationResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

getIntegrationResponse_workflowId :: Lens' GetIntegrationResponse (Maybe Text) Source #

Unique identifier for the workflow.

getIntegrationResponse_httpStatus :: Lens' GetIntegrationResponse Int Source #

The response's http status code.

getIntegrationResponse_domainName :: Lens' GetIntegrationResponse Text Source #

The unique name of the domain.

getIntegrationResponse_uri :: Lens' GetIntegrationResponse Text Source #

The URI of the S3 bucket or any other type of data source.

getIntegrationResponse_createdAt :: Lens' GetIntegrationResponse UTCTime Source #

The timestamp of when the domain was created.

getIntegrationResponse_lastUpdatedAt :: Lens' GetIntegrationResponse UTCTime Source #

The timestamp of when the domain was most recently edited.

GetMatches

getMatches_maxResults :: Lens' GetMatches (Maybe Natural) Source #

The maximum number of results to return per page.

getMatches_nextToken :: Lens' GetMatches (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

getMatches_domainName :: Lens' GetMatches Text Source #

The unique name of the domain.

getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime) Source #

The timestamp this version of Match Result generated.

getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem]) Source #

The list of matched profiles for this instance.

getMatchesResponse_nextToken :: Lens' GetMatchesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

getMatchesResponse_potentialMatches :: Lens' GetMatchesResponse (Maybe Natural) Source #

The number of potential matches found.

getMatchesResponse_httpStatus :: Lens' GetMatchesResponse Int Source #

The response's http status code.

GetProfileObjectType

getProfileObjectType_domainName :: Lens' GetProfileObjectType Text Source #

The unique name of the domain.

getProfileObjectType_objectTypeName :: Lens' GetProfileObjectType Text Source #

The name of the profile object type.

getProfileObjectTypeResponse_allowProfileCreation :: Lens' GetProfileObjectTypeResponse (Maybe Bool) Source #

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

getProfileObjectTypeResponse_createdAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was created.

getProfileObjectTypeResponse_encryptionKey :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #

The customer-provided key to encrypt the profile object that will be created in this profile object type.

getProfileObjectTypeResponse_expirationDays :: Lens' GetProfileObjectTypeResponse (Maybe Natural) Source #

The number of days until the data in the object expires.

getProfileObjectTypeResponse_fields :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

getProfileObjectTypeResponse_keys :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

A list of unique keys that can be used to map data to the profile.

getProfileObjectTypeResponse_lastUpdatedAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was most recently edited.

getProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #

The format of your sourceLastUpdatedTimestamp that was previously set up.

getProfileObjectTypeResponse_tags :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

getProfileObjectTypeResponse_templateId :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #

A unique identifier for the object template.

getProfileObjectTypeResponse_httpStatus :: Lens' GetProfileObjectTypeResponse Int Source #

The response's http status code.

getProfileObjectTypeResponse_objectTypeName :: Lens' GetProfileObjectTypeResponse Text Source #

The name of the profile object type.

getProfileObjectTypeResponse_description :: Lens' GetProfileObjectTypeResponse Text Source #

The description of the profile object type.

GetProfileObjectTypeTemplate

getProfileObjectTypeTemplate_templateId :: Lens' GetProfileObjectTypeTemplate Text Source #

A unique identifier for the object template.

getProfileObjectTypeTemplateResponse_allowProfileCreation :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Bool) Source #

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

getProfileObjectTypeTemplateResponse_fields :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

getProfileObjectTypeTemplateResponse_keys :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

A list of unique keys that can be used to map data to the profile.

getProfileObjectTypeTemplateResponse_sourceLastUpdatedTimestampFormat :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The format of your sourceLastUpdatedTimestamp that was previously set up.

getProfileObjectTypeTemplateResponse_sourceName :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The name of the source of the object template.

getProfileObjectTypeTemplateResponse_sourceObject :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The source of the object template.

getProfileObjectTypeTemplateResponse_templateId :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

A unique identifier for the object template.

getProfileObjectTypeTemplateResponse_httpStatus :: Lens' GetProfileObjectTypeTemplateResponse Int Source #

The response's http status code.

GetWorkflow

getWorkflow_domainName :: Lens' GetWorkflow Text Source #

The unique name of the domain.

getWorkflow_workflowId :: Lens' GetWorkflow Text Source #

Unique identifier for the workflow.

getWorkflowResponse_attributes :: Lens' GetWorkflowResponse (Maybe WorkflowAttributes) Source #

Attributes provided for workflow execution.

getWorkflowResponse_errorDescription :: Lens' GetWorkflowResponse (Maybe Text) Source #

Workflow error messages during execution (if any).

getWorkflowResponse_lastUpdatedAt :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The timestamp that represents when workflow execution last updated.

getWorkflowResponse_metrics :: Lens' GetWorkflowResponse (Maybe WorkflowMetrics) Source #

Workflow specific execution metrics.

getWorkflowResponse_startDate :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The timestamp that represents when workflow execution started.

getWorkflowResponse_status :: Lens' GetWorkflowResponse (Maybe Status) Source #

Status of workflow execution.

getWorkflowResponse_workflowId :: Lens' GetWorkflowResponse (Maybe Text) Source #

Unique identifier for the workflow.

getWorkflowResponse_workflowType :: Lens' GetWorkflowResponse (Maybe WorkflowType) Source #

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

getWorkflowResponse_httpStatus :: Lens' GetWorkflowResponse Int Source #

The response's http status code.

GetWorkflowSteps

getWorkflowSteps_maxResults :: Lens' GetWorkflowSteps (Maybe Natural) Source #

The maximum number of results to return per page.

getWorkflowSteps_nextToken :: Lens' GetWorkflowSteps (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

getWorkflowSteps_domainName :: Lens' GetWorkflowSteps Text Source #

The unique name of the domain.

getWorkflowSteps_workflowId :: Lens' GetWorkflowSteps Text Source #

Unique identifier for the workflow.

getWorkflowStepsResponse_items :: Lens' GetWorkflowStepsResponse (Maybe [WorkflowStepItem]) Source #

List containing workflow step details.

getWorkflowStepsResponse_nextToken :: Lens' GetWorkflowStepsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

getWorkflowStepsResponse_workflowId :: Lens' GetWorkflowStepsResponse (Maybe Text) Source #

Unique identifier for the workflow.

getWorkflowStepsResponse_workflowType :: Lens' GetWorkflowStepsResponse (Maybe WorkflowType) Source #

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

getWorkflowStepsResponse_httpStatus :: Lens' GetWorkflowStepsResponse Int Source #

The response's http status code.

ListAccountIntegrations

listAccountIntegrations_includeHidden :: Lens' ListAccountIntegrations (Maybe Bool) Source #

Boolean to indicate if hidden integration should be returned. Defaults to False.

listAccountIntegrations_maxResults :: Lens' ListAccountIntegrations (Maybe Natural) Source #

The maximum number of objects returned per page.

listAccountIntegrations_nextToken :: Lens' ListAccountIntegrations (Maybe Text) Source #

The pagination token from the previous ListAccountIntegrations API call.

listAccountIntegrations_uri :: Lens' ListAccountIntegrations Text Source #

The URI of the S3 bucket or any other type of data source.

listAccountIntegrationsResponse_items :: Lens' ListAccountIntegrationsResponse (Maybe [ListIntegrationItem]) Source #

The list of ListAccountIntegration instances.

listAccountIntegrationsResponse_nextToken :: Lens' ListAccountIntegrationsResponse (Maybe Text) Source #

The pagination token from the previous ListAccountIntegrations API call.

listAccountIntegrationsResponse_httpStatus :: Lens' ListAccountIntegrationsResponse Int Source #

The response's http status code.

ListDomains

listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #

The maximum number of objects returned per page.

listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #

The pagination token from the previous ListDomain API call.

listDomainsResponse_items :: Lens' ListDomainsResponse (Maybe [ListDomainItem]) Source #

The list of ListDomains instances.

listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #

The pagination token from the previous ListDomains API call.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.

ListIdentityResolutionJobs

listIdentityResolutionJobs_maxResults :: Lens' ListIdentityResolutionJobs (Maybe Natural) Source #

The maximum number of results to return per page.

listIdentityResolutionJobs_nextToken :: Lens' ListIdentityResolutionJobs (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listIdentityResolutionJobs_domainName :: Lens' ListIdentityResolutionJobs Text Source #

The unique name of the domain.

listIdentityResolutionJobsResponse_identityResolutionJobsList :: Lens' ListIdentityResolutionJobsResponse (Maybe [IdentityResolutionJob]) Source #

A list of Identity Resolution Jobs.

listIdentityResolutionJobsResponse_nextToken :: Lens' ListIdentityResolutionJobsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listIdentityResolutionJobsResponse_httpStatus :: Lens' ListIdentityResolutionJobsResponse Int Source #

The response's http status code.

ListIntegrations

listIntegrations_includeHidden :: Lens' ListIntegrations (Maybe Bool) Source #

Boolean to indicate if hidden integration should be returned. Defaults to False.

listIntegrations_maxResults :: Lens' ListIntegrations (Maybe Natural) Source #

The maximum number of objects returned per page.

listIntegrations_nextToken :: Lens' ListIntegrations (Maybe Text) Source #

The pagination token from the previous ListIntegrations API call.

listIntegrations_domainName :: Lens' ListIntegrations Text Source #

The unique name of the domain.

listIntegrationsResponse_items :: Lens' ListIntegrationsResponse (Maybe [ListIntegrationItem]) Source #

The list of ListIntegrations instances.

listIntegrationsResponse_nextToken :: Lens' ListIntegrationsResponse (Maybe Text) Source #

The pagination token from the previous ListIntegrations API call.

listIntegrationsResponse_httpStatus :: Lens' ListIntegrationsResponse Int Source #

The response's http status code.

ListProfileObjectTypeTemplates

listProfileObjectTypeTemplates_maxResults :: Lens' ListProfileObjectTypeTemplates (Maybe Natural) Source #

The maximum number of objects returned per page.

listProfileObjectTypeTemplates_nextToken :: Lens' ListProfileObjectTypeTemplates (Maybe Text) Source #

The pagination token from the previous ListObjectTypeTemplates API call.

listProfileObjectTypeTemplatesResponse_items :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe [ListProfileObjectTypeTemplateItem]) Source #

The list of ListProfileObjectType template instances.

listProfileObjectTypeTemplatesResponse_nextToken :: Lens' ListProfileObjectTypeTemplatesResponse (Maybe Text) Source #

The pagination token from the previous ListObjectTypeTemplates API call.

listProfileObjectTypeTemplatesResponse_httpStatus :: Lens' ListProfileObjectTypeTemplatesResponse Int Source #

The response's http status code.

ListProfileObjectTypes

listProfileObjectTypes_maxResults :: Lens' ListProfileObjectTypes (Maybe Natural) Source #

The maximum number of objects returned per page.

listProfileObjectTypes_nextToken :: Lens' ListProfileObjectTypes (Maybe Text) Source #

Identifies the next page of results to return.

listProfileObjectTypes_domainName :: Lens' ListProfileObjectTypes Text Source #

The unique name of the domain.

listProfileObjectTypesResponse_items :: Lens' ListProfileObjectTypesResponse (Maybe [ListProfileObjectTypeItem]) Source #

The list of ListProfileObjectTypes instances.

listProfileObjectTypesResponse_nextToken :: Lens' ListProfileObjectTypesResponse (Maybe Text) Source #

Identifies the next page of results to return.

listProfileObjectTypesResponse_httpStatus :: Lens' ListProfileObjectTypesResponse Int Source #

The response's http status code.

ListProfileObjects

listProfileObjects_maxResults :: Lens' ListProfileObjects (Maybe Natural) Source #

The maximum number of objects returned per page.

listProfileObjects_nextToken :: Lens' ListProfileObjects (Maybe Text) Source #

The pagination token from the previous call to ListProfileObjects.

listProfileObjects_objectFilter :: Lens' ListProfileObjects (Maybe ObjectFilter) Source #

Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

listProfileObjects_domainName :: Lens' ListProfileObjects Text Source #

The unique name of the domain.

listProfileObjects_objectTypeName :: Lens' ListProfileObjects Text Source #

The name of the profile object type.

listProfileObjects_profileId :: Lens' ListProfileObjects Text Source #

The unique identifier of a customer profile.

listProfileObjectsResponse_items :: Lens' ListProfileObjectsResponse (Maybe [ListProfileObjectsItem]) Source #

The list of ListProfileObject instances.

listProfileObjectsResponse_nextToken :: Lens' ListProfileObjectsResponse (Maybe Text) Source #

The pagination token from the previous call to ListProfileObjects.

listProfileObjectsResponse_httpStatus :: Lens' ListProfileObjectsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of the resource for which you want to view tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListWorkflows

listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #

The maximum number of results to return per page.

listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listWorkflows_queryEndDate :: Lens' ListWorkflows (Maybe UTCTime) Source #

Retrieve workflows ended after timestamp.

listWorkflows_queryStartDate :: Lens' ListWorkflows (Maybe UTCTime) Source #

Retrieve workflows started after timestamp.

listWorkflows_status :: Lens' ListWorkflows (Maybe Status) Source #

Status of workflow execution.

listWorkflows_workflowType :: Lens' ListWorkflows (Maybe WorkflowType) Source #

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

listWorkflows_domainName :: Lens' ListWorkflows Text Source #

The unique name of the domain.

listWorkflowsResponse_items :: Lens' ListWorkflowsResponse (Maybe [ListWorkflowsItem]) Source #

List containing workflow details.

listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listWorkflowsResponse_httpStatus :: Lens' ListWorkflowsResponse Int Source #

The response's http status code.

MergeProfiles

mergeProfiles_fieldSourceProfileIds :: Lens' MergeProfiles (Maybe FieldSourceProfileIds) Source #

The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.

mergeProfiles_domainName :: Lens' MergeProfiles Text Source #

The unique name of the domain.

mergeProfiles_mainProfileId :: Lens' MergeProfiles Text Source #

The identifier of the profile to be taken.

mergeProfiles_profileIdsToBeMerged :: Lens' MergeProfiles (NonEmpty Text) Source #

The identifier of the profile to be merged into MainProfileId.

mergeProfilesResponse_message :: Lens' MergeProfilesResponse (Maybe Text) Source #

A message that indicates the merge request is complete.

mergeProfilesResponse_httpStatus :: Lens' MergeProfilesResponse Int Source #

The response's http status code.

PutIntegration

putIntegration_flowDefinition :: Lens' PutIntegration (Maybe FlowDefinition) Source #

The configuration that controls how Customer Profiles retrieves data from the source.

putIntegration_objectTypeName :: Lens' PutIntegration (Maybe Text) Source #

The name of the profile object type.

putIntegration_objectTypeNames :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

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_tags :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putIntegration_uri :: Lens' PutIntegration (Maybe Text) Source #

The URI of the S3 bucket or any other type of data source.

putIntegration_domainName :: Lens' PutIntegration Text Source #

The unique name of the domain.

putIntegrationResponse_isUnstructured :: Lens' PutIntegrationResponse (Maybe Bool) Source #

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

putIntegrationResponse_objectTypeName :: Lens' PutIntegrationResponse (Maybe Text) Source #

The name of the profile object type.

putIntegrationResponse_objectTypeNames :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

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.

putIntegrationResponse_tags :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putIntegrationResponse_workflowId :: Lens' PutIntegrationResponse (Maybe Text) Source #

Unique identifier for the workflow.

putIntegrationResponse_httpStatus :: Lens' PutIntegrationResponse Int Source #

The response's http status code.

putIntegrationResponse_domainName :: Lens' PutIntegrationResponse Text Source #

The unique name of the domain.

putIntegrationResponse_uri :: Lens' PutIntegrationResponse Text Source #

The URI of the S3 bucket or any other type of data source.

putIntegrationResponse_createdAt :: Lens' PutIntegrationResponse UTCTime Source #

The timestamp of when the domain was created.

putIntegrationResponse_lastUpdatedAt :: Lens' PutIntegrationResponse UTCTime Source #

The timestamp of when the domain was most recently edited.

PutProfileObject

putProfileObject_objectTypeName :: Lens' PutProfileObject Text Source #

The name of the profile object type.

putProfileObject_object :: Lens' PutProfileObject Text Source #

A string that is serialized from a JSON object.

putProfileObject_domainName :: Lens' PutProfileObject Text Source #

The unique name of the domain.

putProfileObjectResponse_profileObjectUniqueKey :: Lens' PutProfileObjectResponse (Maybe Text) Source #

The unique identifier of the profile object generated by the service.

putProfileObjectResponse_httpStatus :: Lens' PutProfileObjectResponse Int Source #

The response's http status code.

PutProfileObjectType

putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (Maybe Bool) Source #

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text) Source #

The customer-provided key to encrypt the profile object that will be created in this profile object type.

putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural) Source #

The number of days until the data in the object expires.

putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey])) Source #

A list of unique keys that can be used to map data to the profile.

putProfileObjectType_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectType (Maybe Text) Source #

The format of your sourceLastUpdatedTimestamp that was previously set up.

putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text) Source #

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

The unique name of the domain.

putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text Source #

The name of the profile object type.

putProfileObjectType_description :: Lens' PutProfileObjectType Text Source #

Description of the profile object type.

putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (Maybe Bool) Source #

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was created.

putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #

The customer-provided key to encrypt the profile object that will be created in this profile object type.

putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural) Source #

The number of days until the data in the object expires.

putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

A list of unique keys that can be used to map data to the profile.

putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was most recently edited.

putProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #

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.

putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #

A unique identifier for the object template.

putProfileObjectTypeResponse_httpStatus :: Lens' PutProfileObjectTypeResponse Int Source #

The response's http status code.

putProfileObjectTypeResponse_objectTypeName :: Lens' PutProfileObjectTypeResponse Text Source #

The name of the profile object type.

putProfileObjectTypeResponse_description :: Lens' PutProfileObjectTypeResponse Text Source #

Description of the profile object type.

SearchProfiles

searchProfiles_additionalSearchKeys :: Lens' SearchProfiles (Maybe (NonEmpty AdditionalSearchKey)) Source #

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.

searchProfiles_logicalOperator :: Lens' SearchProfiles (Maybe LogicalOperator) Source #

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.

searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural) Source #

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text) Source #

The pagination token from the previous SearchProfiles API call.

searchProfiles_domainName :: Lens' SearchProfiles Text Source #

The unique name of the domain.

searchProfiles_keyName :: Lens' SearchProfiles Text Source #

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

searchProfiles_values :: Lens' SearchProfiles [Text] Source #

A list of key values.

searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile]) Source #

The list of Profiles matching the search criteria.

searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text) Source #

The pagination token from the previous SearchProfiles API call.

searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resource that you're adding tags to.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags used to organize, track, or control access for this resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource from which you are removing tags.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The list of tag keys to remove from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateDomain

updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural) Source #

The default number of days until the data within the domain expires.

updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process 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_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

updateDomain_domainName :: Lens' UpdateDomain Text Source #

The unique name of the domain.

updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural) Source #

The default number of days until the data within the domain expires.

updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process 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.

updateDomainResponse_tags :: Lens' UpdateDomainResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #

The response's http status code.

updateDomainResponse_domainName :: Lens' UpdateDomainResponse Text Source #

The unique name of the domain.

updateDomainResponse_createdAt :: Lens' UpdateDomainResponse UTCTime Source #

The timestamp of when the domain was created.

updateDomainResponse_lastUpdatedAt :: Lens' UpdateDomainResponse UTCTime Source #

The timestamp of when the domain was most recently edited.

UpdateProfile

updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text) Source #

A unique account number that you have given to the customer.

updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text) Source #

Any additional information relevant to the customer’s profile.

updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

A generic address associated with the customer that is not mailing, shipping, or billing.

updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text)) Source #

A key value pair of attributes of a customer profile.

updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s billing address.

updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s birth date.

updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s business email address.

updateProfile_businessName :: Lens' UpdateProfile (Maybe Text) Source #

The name of the customer’s business.

updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s business phone number.

updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s email address, which has not been specified as a personal or business address.

updateProfile_firstName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s first name.

updateProfile_gender :: Lens' UpdateProfile (Maybe Gender) Source #

The gender with which the customer identifies.

updateProfile_genderString :: Lens' UpdateProfile (Maybe Text) Source #

An alternative to Gender which accepts any string as input.

updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s home phone number.

updateProfile_lastName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s last name.

updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s mailing address.

updateProfile_middleName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s middle name.

updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s mobile phone number.

updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType) Source #

The type of profile used to describe the customer.

updateProfile_partyTypeString :: Lens' UpdateProfile (Maybe Text) Source #

An alternative to PartyType which accepts any string as input.

updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s personal email address.

updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s phone number, which has not been specified as a mobile, home, or business number.

updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s shipping address.

updateProfile_domainName :: Lens' UpdateProfile Text Source #

The unique name of the domain.

updateProfile_profileId :: Lens' UpdateProfile Text Source #

The unique identifier of a customer profile.

updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int Source #

The response's http status code.

updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text Source #

The unique identifier of a customer profile.

Types

AdditionalSearchKey

additionalSearchKey_keyName :: Lens' AdditionalSearchKey Text Source #

A searchable identifier of a customer profile.

additionalSearchKey_values :: Lens' AdditionalSearchKey [Text] Source #

A list of key values.

Address

address_address1 :: Lens' Address (Maybe Text) Source #

The first line of a customer address.

address_address2 :: Lens' Address (Maybe Text) Source #

The second line of a customer address.

address_address3 :: Lens' Address (Maybe Text) Source #

The third line of a customer address.

address_address4 :: Lens' Address (Maybe Text) Source #

The fourth line of a customer address.

address_city :: Lens' Address (Maybe Text) Source #

The city in which a customer lives.

address_country :: Lens' Address (Maybe Text) Source #

The country in which a customer lives.

address_county :: Lens' Address (Maybe Text) Source #

The county in which a customer lives.

address_postalCode :: Lens' Address (Maybe Text) Source #

The postal code of a customer address.

address_province :: Lens' Address (Maybe Text) Source #

The province in which a customer lives.

address_state :: Lens' Address (Maybe Text) Source #

The state in which a customer lives.

AppflowIntegration

appflowIntegration_batches :: Lens' AppflowIntegration (Maybe [Batch]) Source #

Batches in workflow of type APPFLOW_INTEGRATION.

appflowIntegration_flowDefinition :: Lens' AppflowIntegration FlowDefinition Source #

Undocumented member.

AppflowIntegrationWorkflowAttributes

appflowIntegrationWorkflowAttributes_roleArn :: Lens' AppflowIntegrationWorkflowAttributes (Maybe Text) Source #

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.

appflowIntegrationWorkflowAttributes_sourceConnectorType :: Lens' AppflowIntegrationWorkflowAttributes SourceConnectorType Source #

Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.

appflowIntegrationWorkflowAttributes_connectorProfileName :: Lens' AppflowIntegrationWorkflowAttributes Text Source #

The name of the AppFlow connector profile used for ingestion.

AppflowIntegrationWorkflowMetrics

appflowIntegrationWorkflowMetrics_recordsProcessed :: Lens' AppflowIntegrationWorkflowMetrics Integer Source #

Number of records processed in APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowMetrics_stepsCompleted :: Lens' AppflowIntegrationWorkflowMetrics Integer Source #

Total steps completed in APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowMetrics_totalSteps :: Lens' AppflowIntegrationWorkflowMetrics Integer Source #

Total steps in APPFLOW_INTEGRATION workflow.

AppflowIntegrationWorkflowStep

appflowIntegrationWorkflowStep_flowName :: Lens' AppflowIntegrationWorkflowStep Text Source #

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.

appflowIntegrationWorkflowStep_status :: Lens' AppflowIntegrationWorkflowStep Status Source #

Workflow step status for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_executionMessage :: Lens' AppflowIntegrationWorkflowStep Text Source #

Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_recordsProcessed :: Lens' AppflowIntegrationWorkflowStep Integer Source #

Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_batchRecordsStartTime :: Lens' AppflowIntegrationWorkflowStep Text Source #

Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_batchRecordsEndTime :: Lens' AppflowIntegrationWorkflowStep Text Source #

End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_createdAt :: Lens' AppflowIntegrationWorkflowStep UTCTime Source #

Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.

appflowIntegrationWorkflowStep_lastUpdatedAt :: Lens' AppflowIntegrationWorkflowStep UTCTime Source #

Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.

AutoMerging

autoMerging_conflictResolution :: Lens' AutoMerging (Maybe ConflictResolution) Source #

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?

autoMerging_consolidation :: Lens' AutoMerging (Maybe Consolidation) Source #

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.

autoMerging_minAllowedConfidenceScoreForMerging :: Lens' AutoMerging (Maybe Double) Source #

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.

autoMerging_enabled :: Lens' AutoMerging Bool Source #

The flag that enables the auto-merging of duplicate profiles.

Batch

batch_startTime :: Lens' Batch UTCTime Source #

Start time of batch to split ingestion.

batch_endTime :: Lens' Batch UTCTime Source #

End time of batch to split ingestion.

ConflictResolution

conflictResolution_sourceName :: Lens' ConflictResolution (Maybe Text) Source #

The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

conflictResolution_conflictResolvingModel :: Lens' ConflictResolution ConflictResolvingModel Source #

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, then RECENCY is used again.

ConnectorOperator

connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator) Source #

The operation to be performed on the provided Marketo source fields.

connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator) Source #

The operation to be performed on the provided Amazon S3 source fields.

connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator) Source #

The operation to be performed on the provided Salesforce source fields.

connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator) Source #

The operation to be performed on the provided ServiceNow source fields.

connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator) Source #

The operation to be performed on the provided Zendesk source fields.

Consolidation

consolidation_matchingAttributesList :: Lens' Consolidation (NonEmpty (NonEmpty Text)) Source #

A list of matching criteria.

DomainStats

domainStats_meteringProfileCount :: Lens' DomainStats (Maybe Integer) Source #

The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

domainStats_objectCount :: Lens' DomainStats (Maybe Integer) Source #

The total number of objects in domain.

domainStats_profileCount :: Lens' DomainStats (Maybe Integer) Source #

The total number of profiles currently in the domain.

domainStats_totalSize :: Lens' DomainStats (Maybe Integer) Source #

The total size, in bytes, of all objects in the domain.

ExportingConfig

exportingConfig_s3Exporting :: Lens' ExportingConfig (Maybe S3ExportingConfig) Source #

The S3 location where Identity Resolution Jobs write result files.

ExportingLocation

exportingLocation_s3Exporting :: Lens' ExportingLocation (Maybe S3ExportingLocation) Source #

Information about the S3 location where Identity Resolution Jobs write result files.

FieldSourceProfileIds

fieldSourceProfileIds_accountNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the account number field to be merged.

fieldSourceProfileIds_additionalInformation :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the additional information field to be merged.

fieldSourceProfileIds_address :: 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_billingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the billing type field to be merged.

fieldSourceProfileIds_birthDate :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the birthdate field to be merged.

fieldSourceProfileIds_businessEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the party type field to be merged.

fieldSourceProfileIds_businessName :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the business name field to be merged.

fieldSourceProfileIds_businessPhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the business phone 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_gender :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the gender field to be merged.

fieldSourceProfileIds_homePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the home phone number field to be merged.

fieldSourceProfileIds_lastName :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the last name 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_mobilePhoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the mobile phone number field to be merged.

fieldSourceProfileIds_partyType :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the party type field to be merged.

fieldSourceProfileIds_personalEmailAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the personal email address field to be merged.

fieldSourceProfileIds_phoneNumber :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the phone number field to be merged.

fieldSourceProfileIds_shippingAddress :: Lens' FieldSourceProfileIds (Maybe Text) Source #

A unique identifier for the shipping address field to be merged.

FlowDefinition

flowDefinition_description :: Lens' FlowDefinition (Maybe Text) Source #

A description of the flow you want to create.

flowDefinition_flowName :: Lens' FlowDefinition Text Source #

The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.

flowDefinition_kmsArn :: Lens' FlowDefinition Text Source #

The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.

flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig Source #

The configuration that controls how Customer Profiles retrieves data from the source.

flowDefinition_tasks :: Lens' FlowDefinition [Task] Source #

A list of tasks that Customer Profiles performs while transferring the data in the flow run.

flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig Source #

The trigger settings that determine how and when the flow runs.

FoundByKeyValue

foundByKeyValue_keyName :: Lens' FoundByKeyValue (Maybe Text) Source #

A searchable identifier of a customer profile.

foundByKeyValue_values :: Lens' FoundByKeyValue (Maybe [Text]) Source #

A list of key values.

IdentityResolutionJob

identityResolutionJob_domainName :: Lens' IdentityResolutionJob (Maybe Text) Source #

The unique name of the domain.

identityResolutionJob_exportingLocation :: Lens' IdentityResolutionJob (Maybe ExportingLocation) Source #

The S3 location where the Identity Resolution Job writes result files.

identityResolutionJob_jobEndTime :: Lens' IdentityResolutionJob (Maybe UTCTime) Source #

The timestamp of when the job was completed.

identityResolutionJob_jobId :: Lens' IdentityResolutionJob (Maybe Text) Source #

The unique identifier of the Identity Resolution Job.

identityResolutionJob_jobStartTime :: Lens' IdentityResolutionJob (Maybe UTCTime) Source #

The timestamp of when the job was started or will be started.

identityResolutionJob_jobStats :: Lens' IdentityResolutionJob (Maybe JobStats) Source #

Statistics about an Identity Resolution Job.

identityResolutionJob_message :: Lens' IdentityResolutionJob (Maybe Text) Source #

The error messages that are generated when the Identity Resolution Job runs.

identityResolutionJob_status :: Lens' IdentityResolutionJob (Maybe IdentityResolutionJobStatus) Source #

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 the PENDING 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

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.

IntegrationConfig

integrationConfig_appflowIntegration :: Lens' IntegrationConfig (Maybe AppflowIntegration) Source #

Configuration data for APPFLOW_INTEGRATION workflow type.

JobSchedule

jobSchedule_dayOfTheWeek :: Lens' JobSchedule JobScheduleDayOfTheWeek Source #

The day when the Identity Resolution Job should run every week.

jobSchedule_time :: Lens' JobSchedule Text Source #

The time when the Identity Resolution Job should run every week.

JobStats

jobStats_numberOfMatchesFound :: Lens' JobStats (Maybe Integer) Source #

The number of matches found.

jobStats_numberOfMergesDone :: Lens' JobStats (Maybe Integer) Source #

The number of merges completed.

jobStats_numberOfProfilesReviewed :: Lens' JobStats (Maybe Integer) Source #

The number of profiles reviewed.

ListDomainItem

listDomainItem_tags :: Lens' ListDomainItem (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

listDomainItem_domainName :: Lens' ListDomainItem Text Source #

The unique name of the domain.

listDomainItem_createdAt :: Lens' ListDomainItem UTCTime Source #

The timestamp of when the domain was created.

listDomainItem_lastUpdatedAt :: Lens' ListDomainItem UTCTime Source #

The timestamp of when the domain was most recently edited.

ListIntegrationItem

listIntegrationItem_isUnstructured :: Lens' ListIntegrationItem (Maybe Bool) Source #

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

listIntegrationItem_objectTypeName :: Lens' ListIntegrationItem (Maybe Text) Source #

The name of the profile object type.

listIntegrationItem_objectTypeNames :: Lens' ListIntegrationItem (Maybe (HashMap Text Text)) Source #

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.

listIntegrationItem_tags :: Lens' ListIntegrationItem (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

listIntegrationItem_workflowId :: Lens' ListIntegrationItem (Maybe Text) Source #

Unique identifier for the workflow.

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_createdAt :: Lens' ListIntegrationItem UTCTime Source #

The timestamp of when the domain was created.

listIntegrationItem_lastUpdatedAt :: Lens' ListIntegrationItem UTCTime Source #

The timestamp of when the domain was most recently edited.

ListProfileObjectTypeItem

listProfileObjectTypeItem_createdAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #

The timestamp of when the domain was created.

listProfileObjectTypeItem_lastUpdatedAt :: Lens' ListProfileObjectTypeItem (Maybe UTCTime) Source #

The timestamp of when the domain was most recently edited.

listProfileObjectTypeItem_tags :: Lens' ListProfileObjectTypeItem (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

listProfileObjectTypeItem_objectTypeName :: Lens' ListProfileObjectTypeItem Text Source #

The name of the profile object type.

listProfileObjectTypeItem_description :: Lens' ListProfileObjectTypeItem Text Source #

Description of the profile object type.

ListProfileObjectTypeTemplateItem

listProfileObjectTypeTemplateItem_sourceName :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #

The name of the source of the object template.

listProfileObjectTypeTemplateItem_sourceObject :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #

The source of the object template.

listProfileObjectTypeTemplateItem_templateId :: Lens' ListProfileObjectTypeTemplateItem (Maybe Text) Source #

A unique identifier for the object template.

ListProfileObjectsItem

listProfileObjectsItem_object :: Lens' ListProfileObjectsItem (Maybe Text) Source #

A JSON representation of a ProfileObject that belongs to a profile.

listProfileObjectsItem_objectTypeName :: Lens' ListProfileObjectsItem (Maybe Text) Source #

Specifies the kind of object being added to a profile, such as "Salesforce-Account."

listProfileObjectsItem_profileObjectUniqueKey :: Lens' ListProfileObjectsItem (Maybe Text) Source #

The unique identifier of the ProfileObject generated by the service.

ListWorkflowsItem

listWorkflowsItem_workflowType :: Lens' ListWorkflowsItem WorkflowType Source #

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

listWorkflowsItem_workflowId :: Lens' ListWorkflowsItem Text Source #

Unique identifier for the workflow.

listWorkflowsItem_status :: Lens' ListWorkflowsItem Status Source #

Status of workflow execution.

listWorkflowsItem_statusDescription :: Lens' ListWorkflowsItem Text Source #

Description for workflow execution status.

listWorkflowsItem_createdAt :: Lens' ListWorkflowsItem UTCTime Source #

Creation timestamp for workflow.

listWorkflowsItem_lastUpdatedAt :: Lens' ListWorkflowsItem UTCTime Source #

Last updated timestamp for workflow.

MarketoSourceProperties

marketoSourceProperties_object :: Lens' MarketoSourceProperties Text Source #

The object specified in the Marketo flow source.

MatchItem

matchItem_confidenceScore :: Lens' MatchItem (Maybe Double) Source #

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.

matchItem_matchId :: Lens' MatchItem (Maybe Text) Source #

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.

MatchingRequest

matchingRequest_autoMerging :: Lens' MatchingRequest (Maybe AutoMerging) Source #

Configuration information about the auto-merging process.

matchingRequest_exportingConfig :: Lens' MatchingRequest (Maybe ExportingConfig) Source #

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

matchingRequest_jobSchedule :: Lens' MatchingRequest (Maybe JobSchedule) Source #

The day and time when do you want to start the Identity Resolution Job every week.

matchingRequest_enabled :: Lens' MatchingRequest Bool Source #

The flag that enables the matching process of duplicate profiles.

MatchingResponse

matchingResponse_autoMerging :: Lens' MatchingResponse (Maybe AutoMerging) Source #

Configuration information about the auto-merging process.

matchingResponse_enabled :: Lens' MatchingResponse (Maybe Bool) Source #

The flag that enables the matching process of duplicate profiles.

matchingResponse_exportingConfig :: Lens' MatchingResponse (Maybe ExportingConfig) Source #

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

matchingResponse_jobSchedule :: Lens' MatchingResponse (Maybe JobSchedule) Source #

The day and time when do you want to start the Identity Resolution Job every week.

ObjectFilter

objectFilter_keyName :: Lens' ObjectFilter Text Source #

A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.

objectFilter_values :: Lens' ObjectFilter [Text] Source #

A list of key values.

ObjectTypeField

objectTypeField_contentType :: Lens' ObjectTypeField (Maybe FieldContentType) Source #

The content type of the field. Used for determining equality when searching.

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_target :: Lens' ObjectTypeField (Maybe Text) Source #

The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ObjectTypeKey

objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text]) Source #

The reference for the key name of the fields map.

objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier]) Source #

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, 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

profile_accountNumber :: Lens' Profile (Maybe Text) Source #

A unique account number that you have given to the customer.

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_attributes :: Lens' Profile (Maybe (HashMap Text Text)) Source #

A key value pair of attributes of a customer profile.

profile_billingAddress :: Lens' Profile (Maybe Address) Source #

The customer’s billing address.

profile_birthDate :: Lens' Profile (Maybe Text) Source #

The customer’s birth date.

profile_businessEmailAddress :: Lens' Profile (Maybe Text) Source #

The customer’s business email address.

profile_businessName :: Lens' Profile (Maybe Text) Source #

The name of the customer’s business.

profile_businessPhoneNumber :: Lens' Profile (Maybe Text) Source #

The customer’s home phone number.

profile_emailAddress :: Lens' Profile (Maybe Text) Source #

The customer’s email address, which has not been specified as a personal or business address.

profile_firstName :: Lens' Profile (Maybe Text) Source #

The customer’s first name.

profile_foundByItems :: Lens' Profile (Maybe (NonEmpty FoundByKeyValue)) Source #

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. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems 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.

profile_gender :: Lens' Profile (Maybe Gender) Source #

The gender with which the customer identifies.

profile_homePhoneNumber :: Lens' Profile (Maybe Text) Source #

The customer’s home phone number.

profile_lastName :: Lens' Profile (Maybe Text) Source #

The customer’s last name.

profile_mailingAddress :: Lens' Profile (Maybe Address) Source #

The customer’s mailing address.

profile_middleName :: Lens' Profile (Maybe Text) Source #

The customer’s middle name.

profile_mobilePhoneNumber :: Lens' Profile (Maybe Text) Source #

The customer’s mobile phone number.

profile_partyType :: Lens' Profile (Maybe PartyType) Source #

The type of profile used to describe the customer.

profile_personalEmailAddress :: Lens' Profile (Maybe Text) Source #

The customer’s personal email address.

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_profileId :: Lens' Profile (Maybe Text) Source #

The unique identifier of a customer profile.

profile_shippingAddress :: Lens' Profile (Maybe Address) Source #

The customer’s shipping address.

S3ExportingConfig

s3ExportingConfig_s3KeyName :: Lens' S3ExportingConfig (Maybe Text) Source #

The S3 key name of the location where Identity Resolution Jobs write result files.

s3ExportingConfig_s3BucketName :: Lens' S3ExportingConfig Text Source #

The name of the S3 bucket where Identity Resolution Jobs write result files.

S3ExportingLocation

s3ExportingLocation_s3BucketName :: Lens' S3ExportingLocation (Maybe Text) Source #

The name of the S3 bucket name where Identity Resolution Jobs write result files.

s3ExportingLocation_s3KeyName :: Lens' S3ExportingLocation (Maybe Text) Source #

The S3 key name of the location where Identity Resolution Jobs write result files.

S3SourceProperties

s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text) Source #

The object key for the Amazon S3 bucket in which the source files are stored.

s3SourceProperties_bucketName :: Lens' S3SourceProperties Text Source #

The Amazon S3 bucket name where the source files are stored.

SalesforceSourceProperties

salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool) Source #

The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool) Source #

Indicates whether Amazon AppFlow includes deleted files in the flow run.

salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text Source #

The object specified in the Salesforce flow source.

ScheduledTriggerProperties

scheduledTriggerProperties_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_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #

Specifies the date range for the records to import from the connector in the first flow run.

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_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_scheduleExpression :: Lens' ScheduledTriggerProperties Text Source #

The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

ServiceNowSourceProperties

serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text Source #

The object specified in the ServiceNow flow source.

SourceConnectorProperties

sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties) Source #

The properties that are applied when Marketo is being used as a source.

sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties) Source #

The properties that are applied when Amazon S3 is being used as the flow source.

sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties) Source #

The properties that are applied when Salesforce is being used as a source.

sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties) Source #

The properties that are applied when ServiceNow 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.

SourceFlowConfig

sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text) Source #

The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.

sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig) Source #

Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

sourceFlowConfig_connectorType :: Lens' SourceFlowConfig SourceConnectorType Source #

The type of connector, such as Salesforce, Marketo, and so on.

sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties Source #

Specifies the information that is required to query a particular source connector.