String profileId
The unique identifier of a customer profile.
String keyName
A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.
List<E> values
A list of key values.
String domainName
The unique name of the domain.
String address1
The first line of a customer address.
String address2
The second line of a customer address.
String address3
The third line of a customer address.
String address4
The fourth line of a customer address.
String city
The city in which a customer lives.
String county
The county in which a customer lives.
String state
The state in which a customer lives.
String province
The province in which a customer lives.
String country
The country in which a customer lives.
String postalCode
The postal code of a customer address.
FlowDefinition flowDefinition
List<E> batches
Batches in workflow of type APPFLOW_INTEGRATION.
String sourceConnectorType
Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.
String connectorProfileName
The name of the AppFlow connector profile used for ingestion.
String roleArn
The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
String flowName
Name of the flow created during execution of workflow step. APPFLOW_INTEGRATION workflow type
creates an appflow flow during workflow step execution on the customers behalf.
String status
Workflow step status for APPFLOW_INTEGRATION workflow.
String executionMessage
Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.
Long recordsProcessed
Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION
workflow.
String batchRecordsStartTime
Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION
workflow.
String batchRecordsEndTime
End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION
workflow.
Date createdAt
Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.
Date lastUpdatedAt
Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.
Boolean enabled
The flag that enables the auto-merging of duplicate profiles.
Consolidation consolidation
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
ConflictResolution conflictResolution
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and
Profile B have the same FirstName and LastName (and that is the matching criteria),
which EmailAddress should be used?
Double minAllowedConfidenceScoreForMerging
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
String conflictResolvingModel
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two
departments have merged, data from the specified source is used. If two duplicate profiles are from the same
source, then RECENCY is used again.
String sourceName
The ObjectType name that is used to resolve profile merging conflicts when choosing
SOURCE as the ConflictResolvingModel.
String marketo
The operation to be performed on the provided Marketo source fields.
String s3
The operation to be performed on the provided Amazon S3 source fields.
String salesforce
The operation to be performed on the provided Salesforce source fields.
String serviceNow
The operation to be performed on the provided ServiceNow source fields.
String zendesk
The operation to be performed on the provided Zendesk source fields.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
String deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
MatchingRequest matching
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer
Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in
your domains.
After the Identity Resolution Job completes, use the GetMatches API to
return and review the results. Or, if you have configured ExportingConfig in the
MatchingRequest, you can download the results from S3.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
String deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
MatchingResponse matching
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer
Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in
your domains.
After the Identity Resolution Job completes, use the GetMatches API to
return and review the results. Or, if you have configured ExportingConfig in the
MatchingRequest, you can download the results from S3.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String workflowType
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
IntegrationConfig integrationConfig
Configuration data for integration workflow.
String objectTypeName
The name of the profile object type.
String roleArn
The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String accountNumber
A unique account number that you have given to the customer.
String additionalInformation
Any additional information relevant to the customer’s profile.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer’s phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s business phone number.
String emailAddress
The customer’s email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
Address address
A generic address associated with the customer that is not mailing, shipping, or billing.
Address shippingAddress
The customer’s shipping address.
Address mailingAddress
The customer’s mailing address.
Address billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String profileId
The unique identifier of a customer profile.
String domainName
The unique name of the domain.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String profileId
The unique identifier of a customer profile.
String profileObjectUniqueKey
The unique identifier of the profile object generated by the service.
String objectTypeName
The name of the profile object type.
String domainName
The unique name of the domain.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
Long profileCount
The total number of profiles currently in the domain.
Long meteringProfileCount
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
Long objectCount
The total number of objects in domain.
Long totalSize
The total size, in bytes, of all objects in the domain.
S3ExportingConfig s3Exporting
The S3 location where Identity Resolution Jobs write result files.
S3ExportingLocation s3Exporting
Information about the S3 location where Identity Resolution Jobs write result files.
String accountNumber
A unique identifier for the account number field to be merged.
String additionalInformation
A unique identifier for the additional information field to be merged.
String partyType
A unique identifier for the party type field to be merged.
String businessName
A unique identifier for the business name field to be merged.
String firstName
A unique identifier for the first name field to be merged.
String middleName
A unique identifier for the middle name field to be merged.
String lastName
A unique identifier for the last name field to be merged.
String birthDate
A unique identifier for the birthdate field to be merged.
String gender
A unique identifier for the gender field to be merged.
String phoneNumber
A unique identifier for the phone number field to be merged.
String mobilePhoneNumber
A unique identifier for the mobile phone number field to be merged.
String homePhoneNumber
A unique identifier for the home phone number field to be merged.
String businessPhoneNumber
A unique identifier for the business phone number field to be merged.
String emailAddress
A unique identifier for the email address field to be merged.
String personalEmailAddress
A unique identifier for the personal email address field to be merged.
String businessEmailAddress
A unique identifier for the party type field to be merged.
String address
A unique identifier for the party type field to be merged.
String shippingAddress
A unique identifier for the shipping address field to be merged.
String mailingAddress
A unique identifier for the mailing address field to be merged.
String billingAddress
A unique identifier for the billing type field to be merged.
Map<K,V> attributes
A unique identifier for the attributes field to be merged.
String description
A description of the flow you want to create.
String flowName
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
String kmsArn
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
SourceFlowConfig sourceFlowConfig
The configuration that controls how Customer Profiles retrieves data from the source.
List<E> tasks
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
TriggerConfig triggerConfig
The trigger settings that determine how and when the flow runs.
String domainName
The unique name of the domain.
Consolidation consolidation
A list of matching attributes that represent matching criteria.
ConflictResolution conflictResolution
How the auto-merging process should resolve conflicts between different profiles.
Double minAllowedConfidenceScoreForMerging
Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
String domainName
The unique name of the domain.
Long numberOfMatchesInSample
The number of match groups in the domain that have been reviewed in this preview dry run.
Long numberOfProfilesInSample
The number of profiles found in this preview dry run.
Long numberOfProfilesWillBeMerged
The number of profiles that would be merged if this wasn't a preview dry run.
String domainName
The unique name of the domain.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
String deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
DomainStats stats
Usage-specific statistics about the domain.
MatchingResponse matching
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer
Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in
your domains.
After the Identity Resolution Job completes, use the GetMatches API to
return and review the results. Or, if you have configured ExportingConfig in the
MatchingRequest, you can download the results from S3.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String jobId
The unique identifier of the Identity Resolution Job.
String status
The status of the Identity Resolution Job.
PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the
Identity Resolution feature in your domain, jobs in 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.
String message
The error messages that are generated when the Identity Resolution Job runs.
Date jobStartTime
The timestamp of when the Identity Resolution Job was started or will be started.
Date jobEndTime
The timestamp of when the Identity Resolution Job was completed.
Date lastUpdatedAt
The timestamp of when the Identity Resolution Job was most recently edited.
Date jobExpirationTime
The timestamp of when the Identity Resolution Job will expire.
AutoMerging autoMerging
Configuration settings for how to perform the auto-merging of profiles.
ExportingLocation exportingLocation
The S3 location where the Identity Resolution Job writes result files.
JobStats jobStats
Statistics about the Identity Resolution Job.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
Map<K,V> objectTypeNames
A map in which each key is an event type from an external application such as Segment or Shopify, and each value
is an ObjectTypeName (template) used to ingest the event. It supports the following event types:
SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers,
ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders,
and ShopifyUpdatedOrders.
String workflowId
Unique identifier for the workflow.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per page.
String domainName
The unique name of the domain.
String nextToken
If there are additional results, this is the token for the next set of results.
Date matchGenerationDate
The timestamp this version of Match Result generated.
Integer potentialMatches
The number of potential matches found.
List<E> matches
The list of matched profiles for this instance.
String objectTypeName
The name of the profile object type.
String description
The description of the profile object type.
String templateId
A unique identifier for the object template.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this
type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the
service tries to fetch a standard profile and associate this object with the profile. If it is set to
TRUE, and if no match is found, then the service creates a new standard profile.
String sourceLastUpdatedTimestampFormat
The format of your sourceLastUpdatedTimestamp that was previously set up.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String templateId
A unique identifier for the object template.
String templateId
A unique identifier for the object template.
String sourceName
The name of the source of the object template.
String sourceObject
The source of the object template.
Boolean allowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this
type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the
service tries to fetch a standard profile and associate this object with the profile. If it is set to
TRUE, and if no match is found, then the service creates a new standard profile.
String sourceLastUpdatedTimestampFormat
The format of your sourceLastUpdatedTimestamp that was previously set up.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
String workflowId
Unique identifier for the workflow.
String workflowType
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
String status
Status of workflow execution.
String errorDescription
Workflow error messages during execution (if any).
Date startDate
The timestamp that represents when workflow execution started.
Date lastUpdatedAt
The timestamp that represents when workflow execution last updated.
WorkflowAttributes attributes
Attributes provided for workflow execution.
WorkflowMetrics metrics
Workflow specific execution metrics.
String domainName
The unique name of the domain.
String workflowId
Unique identifier for the workflow.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per page.
String workflowId
Unique identifier for the workflow.
String workflowType
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
List<E> items
List containing workflow step details.
String nextToken
If there are additional results, this is the token for the next set of results.
String domainName
The unique name of the domain.
String jobId
The unique identifier of the Identity Resolution Job.
String status
The status of the Identity Resolution Job.
PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the
Identity Resolution feature in your domain, jobs in 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.
Date jobStartTime
The timestamp of when the job was started or will be started.
Date jobEndTime
The timestamp of when the job was completed.
JobStats jobStats
Statistics about an Identity Resolution Job.
ExportingLocation exportingLocation
The S3 location where the Identity Resolution Job writes result files.
String message
The error messages that are generated when the Identity Resolution Job runs.
String datetimeTypeFieldName
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
AppflowIntegration appflowIntegration
Configuration data for APPFLOW_INTEGRATION workflow type.
String uri
The URI of the S3 bucket or any other type of data source.
String nextToken
The pagination token from the previous ListAccountIntegrations API call.
Integer maxResults
The maximum number of objects returned per page.
Boolean includeHidden
Boolean to indicate if hidden integration should be returned. Defaults to False.
String domainName
The unique name of the domain.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per page.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
Map<K,V> objectTypeNames
A map in which each key is an event type from an external application such as Segment or Shopify, and each value
is an ObjectTypeName (template) used to ingest the event. It supports the following event types:
SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers,
ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders,
and ShopifyUpdatedOrders.
String workflowId
Unique identifier for the workflow.
String domainName
The unique name of the domain.
String nextToken
The pagination token from the previous ListIntegrations API call.
Integer maxResults
The maximum number of objects returned per page.
Boolean includeHidden
Boolean to indicate if hidden integration should be returned. Defaults to False.
String objectTypeName
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
String profileObjectUniqueKey
The unique identifier of the ProfileObject generated by the service.
String object
A JSON representation of a ProfileObject that belongs to a profile.
String nextToken
The pagination token from the previous call to ListProfileObjects.
Integer maxResults
The maximum number of objects returned per page.
String domainName
The unique name of the domain.
String objectTypeName
The name of the profile object type.
String profileId
The unique identifier of a customer profile.
ObjectFilter objectFilter
Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String resourceArn
The ARN of the resource for which you want to view tags.
String workflowType
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
String workflowId
Unique identifier for the workflow.
String status
Status of workflow execution.
String statusDescription
Description for workflow execution status.
Date createdAt
Creation timestamp for workflow.
Date lastUpdatedAt
Last updated timestamp for workflow.
String domainName
The unique name of the domain.
String workflowType
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
String status
Status of workflow execution.
Date queryStartDate
Retrieve workflows started after timestamp.
Date queryEndDate
Retrieve workflows ended after timestamp.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per page.
String object
The object specified in the Marketo flow source.
Boolean enabled
The flag that enables the matching process of duplicate profiles.
JobSchedule jobSchedule
The day and time when do you want to start the Identity Resolution Job every week.
AutoMerging autoMerging
Configuration information about the auto-merging process.
ExportingConfig exportingConfig
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
Boolean enabled
The flag that enables the matching process of duplicate profiles.
JobSchedule jobSchedule
The day and time when do you want to start the Identity Resolution Job every week.
AutoMerging autoMerging
Configuration information about the auto-merging process.
ExportingConfig exportingConfig
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
String matchId
The unique identifiers for this group of profiles that match.
List<E> profileIds
A list of identifiers for profiles that match.
Double confidenceScore
A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.
String domainName
The unique name of the domain.
String mainProfileId
The identifier of the profile to be taken.
List<E> profileIdsToBeMerged
The identifier of the profile to be merged into MainProfileId.
FieldSourceProfileIds fieldSourceProfileIds
The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.
String message
A message that indicates the merge request is complete.
String keyName
A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.
List<E> values
A list of key values.
String 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.
String target
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
String contentType
The content type of the field. Used for determining equality when searching.
List<E> standardIdentifiers
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
List<E> fieldNames
The reference for the key name of the fields map.
String profileId
The unique identifier of a customer profile.
String accountNumber
A unique account number that you have given to the customer.
String additionalInformation
Any additional information relevant to the customer’s profile.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer's phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s home phone number.
String emailAddress
The customer’s email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
Address address
A generic address associated with the customer that is not mailing, shipping, or billing.
Address shippingAddress
The customer’s shipping address.
Address mailingAddress
The customer’s mailing address.
Address billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
FlowDefinition flowDefinition
The configuration that controls how Customer Profiles retrieves data from the source.
Map<K,V> objectTypeNames
A map in which each key is an event type from an external application such as Segment or Shopify, and each value
is an ObjectTypeName (template) used to ingest the event. It supports the following event types:
SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers,
ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders,
and ShopifyUpdatedOrders.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
Map<K,V> objectTypeNames
A map in which each key is an event type from an external application such as Segment or Shopify, and each value
is an ObjectTypeName (template) used to ingest the event. It supports the following event types:
SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers,
ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders,
and ShopifyUpdatedOrders.
String workflowId
Unique identifier for the workflow.
String profileObjectUniqueKey
The unique identifier of the profile object generated by the service.
String domainName
The unique name of the domain.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
String templateId
A unique identifier for the object template. For some attributes in the request, the service will use the default
value from the object template when TemplateId is present. If these attributes are present in the request, the
service may return a BadRequestException. These attributes include: AllowProfileCreation,
SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when
TemplateId is set, the service may return a BadRequestException.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this
type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the
service tries to fetch a standard profile and associate this object with the profile. If it is set to
TRUE, and if no match is found, then the service creates a new standard profile.
String sourceLastUpdatedTimestampFormat
The format of your sourceLastUpdatedTimestamp that was previously set up.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
String templateId
A unique identifier for the object template.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this
type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the
service tries to fetch a standard profile and associate this object with the profile. If it is set to
TRUE, and if no match is found, then the service creates a new standard profile.
String sourceLastUpdatedTimestampFormat
The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed
using SimpleDateFormat.
If you have sourceLastUpdatedTimestamp in your field, you must set up
sourceLastUpdatedTimestampFormat.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String object
The object specified in the Salesforce flow source.
Boolean enableDynamicFieldUpdate
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Boolean includeDeletedRecords
Indicates whether Amazon AppFlow includes deleted files in the flow run.
String scheduleExpression
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
String dataPullMode
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Date scheduleStartTime
Specifies the scheduled start time for a scheduled-trigger flow.
Date scheduleEndTime
Specifies the scheduled end time for a scheduled-trigger flow.
String timezone
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
Long scheduleOffset
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Date firstExecutionFrom
Specifies the date range for the records to import from the connector in the first flow run.
String nextToken
The pagination token from the previous SearchProfiles API call.
Integer maxResults
The maximum number of objects returned per page.
String domainName
The unique name of the domain.
String keyName
A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.
List<E> values
A list of key values.
String object
The object specified in the ServiceNow flow source.
MarketoSourceProperties marketo
The properties that are applied when Marketo is being used as a source.
S3SourceProperties s3
The properties that are applied when Amazon S3 is being used as the flow source.
SalesforceSourceProperties salesforce
The properties that are applied when Salesforce is being used as a source.
ServiceNowSourceProperties serviceNow
The properties that are applied when ServiceNow is being used as a source.
ZendeskSourceProperties zendesk
The properties that are applied when using Zendesk as a flow source.
String connectorProfileName
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
String connectorType
The type of connector, such as Salesforce, Marketo, and so on.
IncrementalPullConfig incrementalPullConfig
Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
SourceConnectorProperties sourceConnectorProperties
Specifies the information that is required to query a particular source connector.
ConnectorOperator connectorOperator
The operation to be performed on the provided source fields.
String destinationField
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
List<E> sourceFields
The source fields to which a particular task is applied.
Map<K,V> taskProperties
A map used to store task-related information. The service looks for particular information based on the TaskType.
String taskType
Specifies the particular task implementation that Amazon AppFlow performs.
String triggerType
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
TriggerProperties triggerProperties
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
ScheduledTriggerProperties scheduled
Specifies the configuration details of a schedule-triggered flow that you define.
String address1
The first line of a customer address.
String address2
The second line of a customer address.
String address3
The third line of a customer address.
String address4
The fourth line of a customer address.
String city
The city in which a customer lives.
String county
The county in which a customer lives.
String state
The state in which a customer lives.
String province
The province in which a customer lives.
String country
The country in which a customer lives.
String postalCode
The postal code of a customer address.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
String deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
MatchingRequest matching
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer
Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in
your domains.
After the Identity Resolution Job completes, use the GetMatches API to
return and review the results. Or, if you have configured ExportingConfig in the
MatchingRequest, you can download the results from S3.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
String deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
MatchingResponse matching
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer
Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in
your domains.
After the Identity Resolution Job completes, use the GetMatches API to
return and review the results. Or, if you have configured ExportingConfig in the
MatchingRequest, you can download the results from S3.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String profileId
The unique identifier of a customer profile.
String additionalInformation
Any additional information relevant to the customer’s profile.
String accountNumber
A unique account number that you have given to the customer.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer’s phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s business phone number.
String emailAddress
The customer’s email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
UpdateAddress address
A generic address associated with the customer that is not mailing, shipping, or billing.
UpdateAddress shippingAddress
The customer’s shipping address.
UpdateAddress mailingAddress
The customer’s mailing address.
UpdateAddress billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String profileId
The unique identifier of a customer profile.
AppflowIntegrationWorkflowAttributes appflowIntegration
Workflow attributes specific to APPFLOW_INTEGRATION workflow.
AppflowIntegrationWorkflowMetrics appflowIntegration
Workflow execution metrics for APPFLOW_INTEGRATION workflow.
AppflowIntegrationWorkflowStep appflowIntegration
Workflow step information specific to APPFLOW_INTEGRATION workflow.
String object
The object specified in the Zendesk flow source.
Copyright © 2022. All rights reserved.