Table of Contents
CustomerProfiles.Client¶A low-level client representing Amazon Connect Customer Profiles
Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.
import boto3
client = boto3.client('customer-profiles')
These are the available methods:
add_profile_key()can_paginate()close()create_domain()create_integration_workflow()create_profile()delete_domain()delete_integration()delete_profile()delete_profile_key()delete_profile_object()delete_profile_object_type()delete_workflow()get_auto_merging_preview()get_domain()get_identity_resolution_job()get_integration()get_matches()get_paginator()get_profile_object_type()get_profile_object_type_template()get_waiter()get_workflow()get_workflow_steps()list_account_integrations()list_domains()list_identity_resolution_jobs()list_integrations()list_profile_object_type_templates()list_profile_object_types()list_profile_objects()list_tags_for_resource()list_workflows()merge_profiles()put_integration()put_profile_object()put_profile_object_type()search_profiles()tag_resource()untag_resource()update_domain()update_profile()add_profile_key(**kwargs)¶Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
See also: AWS API Documentation
Request Syntax
response = client.add_profile_key(
ProfileId='string',
KeyName='string',
Values=[
'string',
],
DomainName='string'
)
[REQUIRED]
The unique identifier of a customer profile.
[REQUIRED]
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.
[REQUIRED]
A list of key values.
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'KeyName': 'string',
'Values': [
'string',
]
}
Response Structure
(dict) --
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_domain(**kwargs)¶Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to enable identity resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
See also: AWS API Documentation
Request Syntax
response = client.create_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The default number of days until the data within the domain expires.
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.
The flag that enables the matching process of duplicate profiles.
The day and time when do you want to start the Identity Resolution Job every week.
The day when the Identity Resolution Job should run every week.
The time when the Identity Resolution Job should run every week.
Configuration information about the auto-merging process.
The flag that enables the auto-merging of duplicate profiles.
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.
A list of matching criteria.
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?
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.The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
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.
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
The S3 location where Identity Resolution Jobs write result files.
The name of the S3 bucket where Identity Resolution Jobs write result files.
The S3 key name of the location where Identity Resolution Jobs write result files.
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
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.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
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.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
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.SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
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.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptioncreate_integration_workflow(**kwargs)¶Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
See also: AWS API Documentation
Request Syntax
response = client.create_integration_workflow(
DomainName='string',
WorkflowType='APPFLOW_INTEGRATION',
IntegrationConfig={
'AppflowIntegration': {
'FlowDefinition': {
'Description': 'string',
'FlowName': 'string',
'KmsArn': 'string',
'SourceFlowConfig': {
'ConnectorProfileName': 'string',
'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
'IncrementalPullConfig': {
'DatetimeTypeFieldName': 'string'
},
'SourceConnectorProperties': {
'Marketo': {
'Object': 'string'
},
'S3': {
'BucketName': 'string',
'BucketPrefix': 'string'
},
'Salesforce': {
'Object': 'string',
'EnableDynamicFieldUpdate': True|False,
'IncludeDeletedRecords': True|False
},
'ServiceNow': {
'Object': 'string'
},
'Zendesk': {
'Object': 'string'
}
}
},
'Tasks': [
{
'ConnectorOperator': {
'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
},
'DestinationField': 'string',
'SourceFields': [
'string',
],
'TaskProperties': {
'string': 'string'
},
'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
},
],
'TriggerConfig': {
'TriggerType': 'Scheduled'|'Event'|'OnDemand',
'TriggerProperties': {
'Scheduled': {
'ScheduleExpression': 'string',
'DataPullMode': 'Incremental'|'Complete',
'ScheduleStartTime': datetime(2015, 1, 1),
'ScheduleEndTime': datetime(2015, 1, 1),
'Timezone': 'string',
'ScheduleOffset': 123,
'FirstExecutionFrom': datetime(2015, 1, 1)
}
}
}
},
'Batches': [
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
]
}
},
ObjectTypeName='string',
RoleArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
[REQUIRED]
Configuration data for integration workflow.
Configuration data for APPFLOW_INTEGRATION workflow type.
The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
A description of the flow you want to create.
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
The configuration that controls how Customer Profiles retrieves data from the source.
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
The type of connector, such as Salesforce, Marketo, and so on.
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.
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
Specifies the information that is required to query a particular source connector.
The properties that are applied when Marketo is being used as a source.
The object specified in the Marketo flow source.
The properties that are applied when Amazon S3 is being used as the flow source.
The Amazon S3 bucket name where the source files are stored.
The object key for the Amazon S3 bucket in which the source files are stored.
The properties that are applied when Salesforce is being used as a source.
The object specified in the Salesforce flow source.
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Indicates whether Amazon AppFlow includes deleted files in the flow run.
The properties that are applied when ServiceNow is being used as a source.
The object specified in the ServiceNow flow source.
The properties that are applied when using Zendesk as a flow source.
The object specified in the Zendesk flow source.
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
The operation to be performed on the provided source fields.
The operation to be performed on the provided Marketo source fields.
The operation to be performed on the provided Amazon S3 source fields.
The operation to be performed on the provided Salesforce source fields.
The operation to be performed on the provided ServiceNow source fields.
The operation to be performed on the provided Zendesk source fields.
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
The source fields to which a particular task is applied.
A map used to store task-related information. The service looks for particular information based on the TaskType.
Specifies the particular task implementation that Amazon AppFlow performs.
The trigger settings that determine how and when the flow runs.
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow that you define.
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Specifies the scheduled start time for a scheduled-trigger flow.
Specifies the scheduled end time for a scheduled-trigger flow.
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Specifies the date range for the records to import from the connector in the first flow run.
Batches in workflow of type APPFLOW_INTEGRATION .
Batch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.
Start time of batch to split ingestion.
End time of batch to split ingestion.
[REQUIRED]
The name of the profile object type.
[REQUIRED]
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.
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{
'WorkflowId': 'string',
'Message': 'string'
}
Response Structure
(dict) --
WorkflowId (string) --
Unique identifier for the workflow.
Message (string) --
A message indicating create request was received.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptioncreate_profile(**kwargs)¶Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
See also: AWS API Documentation
Request Syntax
response = client.create_profile(
DomainName='string',
AccountNumber='string',
AdditionalInformation='string',
PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
BusinessName='string',
FirstName='string',
MiddleName='string',
LastName='string',
BirthDate='string',
Gender='MALE'|'FEMALE'|'UNSPECIFIED',
PhoneNumber='string',
MobilePhoneNumber='string',
HomePhoneNumber='string',
BusinessPhoneNumber='string',
EmailAddress='string',
PersonalEmailAddress='string',
BusinessEmailAddress='string',
Address={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
ShippingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
MailingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
BillingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
Attributes={
'string': 'string'
},
PartyTypeString='string',
GenderString='string'
)
[REQUIRED]
The unique name of the domain.
A generic address associated with the customer that is not mailing, shipping, or billing.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s shipping address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s mailing address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s billing address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
A key value pair of attributes of a customer profile.
PartyType which accepts any string as input.Gender which accepts any string as input.dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_domain(**kwargs)¶Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain(
DomainName='string'
)
[REQUIRED]
The unique name of the domain.
{
'Message': 'string'
}
Response Structure
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_integration(**kwargs)¶Removes an integration from a specific domain.
See also: AWS API Documentation
Request Syntax
response = client.delete_integration(
DomainName='string',
Uri='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_profile(**kwargs)¶Deletes the standard customer profile and all data pertaining to the profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile(
ProfileId='string',
DomainName='string'
)
[REQUIRED]
The unique identifier of a customer profile.
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_profile_key(**kwargs)¶Removes a searchable key from a customer profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile_key(
ProfileId='string',
KeyName='string',
Values=[
'string',
],
DomainName='string'
)
[REQUIRED]
The unique identifier of a customer profile.
[REQUIRED]
A searchable identifier of a customer profile.
[REQUIRED]
A list of key values.
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_profile_object(**kwargs)¶Removes an object associated with a profile of a given ProfileObjectType.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile_object(
ProfileId='string',
ProfileObjectUniqueKey='string',
ObjectTypeName='string',
DomainName='string'
)
[REQUIRED]
The unique identifier of a customer profile.
[REQUIRED]
The unique identifier of the profile object generated by the service.
[REQUIRED]
The name of the profile object type.
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_profile_object_type(**kwargs)¶Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile_object_type(
DomainName='string',
ObjectTypeName='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiondelete_workflow(**kwargs)¶Deletes the specified workflow and all its corresponding resources. This is an async process.
See also: AWS API Documentation
Request Syntax
response = client.delete_workflow(
DomainName='string',
WorkflowId='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
Unique identifier for the workflow.
dict
Response Syntax
{}
Response Structure
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_auto_merging_preview(**kwargs)¶Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
Warning
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName ), there may be a large number of matches. This increases the chances of erroneous merges.
See also: AWS API Documentation
Request Syntax
response = client.get_auto_merging_preview(
DomainName='string',
Consolidation={
'MatchingAttributesList': [
[
'string',
],
]
},
ConflictResolution={
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
MinAllowedConfidenceScoreForMerging=123.0
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
A list of matching attributes that represent matching criteria.
A list of matching criteria.
[REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
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.The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
dict
Response Syntax
{
'DomainName': 'string',
'NumberOfMatchesInSample': 123,
'NumberOfProfilesInSample': 123,
'NumberOfProfilesWillBeMerged': 123
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
NumberOfMatchesInSample (integer) --
The number of match groups in the domain that have been reviewed in this preview dry run.
NumberOfProfilesInSample (integer) --
The number of profiles found in this preview dry run.
NumberOfProfilesWillBeMerged (integer) --
The number of profiles that would be merged if this wasn't a preview dry run.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_domain(**kwargs)¶Returns information about a specific domain.
See also: AWS API Documentation
Request Syntax
response = client.get_domain(
DomainName='string'
)
[REQUIRED]
The unique name of the domain.
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Stats': {
'ProfileCount': 123,
'MeteringProfileCount': 123,
'ObjectCount': 123,
'TotalSize': 123
},
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
The unique name of the domain.
The default number of days until the data within the domain expires.
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.
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Usage-specific statistics about the domain.
The total number of profiles currently in the domain.
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.
The total number of objects in domain.
The total size, in bytes, of all objects in the domain.
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.
The flag that enables the matching process of duplicate profiles.
The day and time when do you want to start the Identity Resolution Job every week.
The day when the Identity Resolution Job should run every week.
The time when the Identity Resolution Job should run every week.
Configuration information about the auto-merging process.
The flag that enables the auto-merging of duplicate profiles.
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.
A list of matching criteria.
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?
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.The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
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.
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
The S3 location where Identity Resolution Jobs write result files.
The name of the S3 bucket where Identity Resolution Jobs write result files.
The S3 key name of the location where Identity Resolution Jobs write result files.
The timestamp of when the domain was created.
The timestamp of when the domain was most recently edited.
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_identity_resolution_job(**kwargs)¶Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
See also: AWS API Documentation
Request Syntax
response = client.get_identity_resolution_job(
DomainName='string',
JobId='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The unique identifier of the Identity Resolution Job.
dict
Response Syntax
{
'DomainName': 'string',
'JobId': 'string',
'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
'Message': 'string',
'JobStartTime': datetime(2015, 1, 1),
'JobEndTime': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'JobExpirationTime': datetime(2015, 1, 1),
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingLocation': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
},
'JobStats': {
'NumberOfProfilesReviewed': 123,
'NumberOfMatchesFound': 123,
'NumberOfMergesDone': 123
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
JobId (string) --
The unique identifier of the Identity Resolution Job.
Status (string) --
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.Message (string) --
The error messages that are generated when the Identity Resolution Job runs.
JobStartTime (datetime) --
The timestamp of when the Identity Resolution Job was started or will be started.
JobEndTime (datetime) --
The timestamp of when the Identity Resolution Job was completed.
LastUpdatedAt (datetime) --
The timestamp of when the Identity Resolution Job was most recently edited.
JobExpirationTime (datetime) --
The timestamp of when the Identity Resolution Job will expire.
AutoMerging (dict) --
Configuration settings for how to perform the auto-merging of profiles.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
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.SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
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.
ExportingLocation (dict) --
The S3 location where the Identity Resolution Job writes result files.
S3Exporting (dict) --
Information about the S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket name where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
JobStats (dict) --
Statistics about the Identity Resolution Job.
NumberOfProfilesReviewed (integer) --
The number of profiles reviewed.
NumberOfMatchesFound (integer) --
The number of matches found.
NumberOfMergesDone (integer) --
The number of merges completed.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_integration(**kwargs)¶Returns an integration for a domain.
See also: AWS API Documentation
Request Syntax
response = client.get_integration(
DomainName='string',
Uri='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
ObjectTypeNames (dict) --
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 .
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (boolean) --
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_matches(**kwargs)¶Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.
Warning
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.
Amazon Connect uses the following profile attributes to identify matches:
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe , or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com , or different phone number formats such as 555-010-0000 and +1-555-010-0000 —can be detected as belonging to the same customer John Doe and merged into a unified profile.
See also: AWS API Documentation
Request Syntax
response = client.get_matches(
NextToken='string',
MaxResults=123,
DomainName='string'
)
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'NextToken': 'string',
'MatchGenerationDate': datetime(2015, 1, 1),
'PotentialMatches': 123,
'Matches': [
{
'MatchId': 'string',
'ProfileIds': [
'string',
],
'ConfidenceScore': 123.0
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
MatchGenerationDate (datetime) --
The timestamp this version of Match Result generated.
PotentialMatches (integer) --
The number of potential matches found.
Matches (list) --
The list of matched profiles for this instance.
(dict) --
The Match group object.
MatchId (string) --
The unique identifiers for this group of profiles that match.
ProfileIds (list) --
A list of identifiers for profiles that match.
ConfidenceScore (float) --
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.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_profile_object_type(**kwargs)¶Returns the object types for a specific domain.
See also: AWS API Documentation
Request Syntax
response = client.get_profile_object_type(
DomainName='string',
ObjectTypeName='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY'|'ORDER',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
The description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
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.
SourceLastUpdatedTimestampFormat (string) --
The format of your sourceLastUpdatedTimestamp that was previously set up.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
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.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
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.
FieldNames (list) --
The reference for the key name of the fields map.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_profile_object_type_template(**kwargs)¶Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
See also: AWS API Documentation
Request Syntax
response = client.get_profile_object_type_template(
TemplateId='string'
)
[REQUIRED]
A unique identifier for the object template.
{
'TemplateId': 'string',
'SourceName': 'string',
'SourceObject': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY'|'ORDER',
],
'FieldNames': [
'string',
]
},
]
}
}
Response Structure
A unique identifier for the object template.
The name of the source of the object template.
The source of the object template.
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.
The format of your sourceLastUpdatedTimestamp that was previously set up.
A map of the name and ObjectType field.
Represents a field in a ProfileObjectType.
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.
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
The content type of the field. Used for determining equality when searching.
A list of unique keys that can be used to map data to the profile.
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
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.
The reference for the key name of the fields map.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
get_workflow(**kwargs)¶Get details of specified workflow.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow(
DomainName='string',
WorkflowId='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
Unique identifier for the workflow.
dict
Response Syntax
{
'WorkflowId': 'string',
'WorkflowType': 'APPFLOW_INTEGRATION',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
'ErrorDescription': 'string',
'StartDate': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Attributes': {
'AppflowIntegration': {
'SourceConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
'ConnectorProfileName': 'string',
'RoleArn': 'string'
}
},
'Metrics': {
'AppflowIntegration': {
'RecordsProcessed': 123,
'StepsCompleted': 123,
'TotalSteps': 123
}
}
}
Response Structure
(dict) --
WorkflowId (string) --
Unique identifier for the workflow.
WorkflowType (string) --
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
Status (string) --
Status of workflow execution.
ErrorDescription (string) --
Workflow error messages during execution (if any).
StartDate (datetime) --
The timestamp that represents when workflow execution started.
LastUpdatedAt (datetime) --
The timestamp that represents when workflow execution last updated.
Attributes (dict) --
Attributes provided for workflow execution.
AppflowIntegration (dict) --
Workflow attributes specific to APPFLOW_INTEGRATION workflow.
SourceConnectorType (string) --
Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.
ConnectorProfileName (string) --
The name of the AppFlow connector profile used for ingestion.
RoleArn (string) --
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.
Metrics (dict) --
Workflow specific execution metrics.
AppflowIntegration (dict) --
Workflow execution metrics for APPFLOW_INTEGRATION workflow.
RecordsProcessed (integer) --
Number of records processed in APPFLOW_INTEGRATION workflow.
StepsCompleted (integer) --
Total steps completed in APPFLOW_INTEGRATION workflow.
TotalSteps (integer) --
Total steps in APPFLOW_INTEGRATION workflow.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionget_workflow_steps(**kwargs)¶Get granular list of steps in workflow.
See also: AWS API Documentation
Request Syntax
response = client.get_workflow_steps(
DomainName='string',
WorkflowId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
Unique identifier for the workflow.
dict
Response Syntax
{
'WorkflowId': 'string',
'WorkflowType': 'APPFLOW_INTEGRATION',
'Items': [
{
'AppflowIntegration': {
'FlowName': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
'ExecutionMessage': 'string',
'RecordsProcessed': 123,
'BatchRecordsStartTime': 'string',
'BatchRecordsEndTime': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkflowId (string) --
Unique identifier for the workflow.
WorkflowType (string) --
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
Items (list) --
List containing workflow step details.
(dict) --
List containing steps in workflow.
AppflowIntegration (dict) --
Workflow step information specific to APPFLOW_INTEGRATION workflow.
FlowName (string) --
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.
Status (string) --
Workflow step status for APPFLOW_INTEGRATION workflow.
ExecutionMessage (string) --
Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.
RecordsProcessed (integer) --
Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION workflow.
BatchRecordsStartTime (string) --
Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
BatchRecordsEndTime (string) --
End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.
CreatedAt (datetime) --
Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.
LastUpdatedAt (datetime) --
Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_account_integrations(**kwargs)¶Lists all of the integrations associated to a specific URI in the AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_account_integrations(
Uri='string',
NextToken='string',
MaxResults=123,
IncludeHidden=True|False
)
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
False .dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListAccountIntegration instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
ObjectTypeNames (dict) --
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 .
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (boolean) --
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
NextToken (string) --
The pagination token from the previous ListAccountIntegrations API call.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_domains(**kwargs)¶Returns a list of all the domains for an AWS account that have been created.
See also: AWS API Documentation
Request Syntax
response = client.list_domains(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListDomains instances.
(dict) --
An object in a list that represents a domain.
DomainName (string) --
The unique name of the domain.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
NextToken (string) --
The pagination token from the previous ListDomains API call.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_identity_resolution_jobs(**kwargs)¶Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime .
See also: AWS API Documentation
Request Syntax
response = client.list_identity_resolution_jobs(
DomainName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'IdentityResolutionJobsList': [
{
'DomainName': 'string',
'JobId': 'string',
'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
'JobStartTime': datetime(2015, 1, 1),
'JobEndTime': datetime(2015, 1, 1),
'JobStats': {
'NumberOfProfilesReviewed': 123,
'NumberOfMatchesFound': 123,
'NumberOfMergesDone': 123
},
'ExportingLocation': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
},
'Message': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IdentityResolutionJobsList (list) --
A list of Identity Resolution Jobs.
(dict) --
Information about the Identity Resolution Job.
DomainName (string) --
The unique name of the domain.
JobId (string) --
The unique identifier of the Identity Resolution Job.
Status (string) --
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.JobStartTime (datetime) --
The timestamp of when the job was started or will be started.
JobEndTime (datetime) --
The timestamp of when the job was completed.
JobStats (dict) --
Statistics about an Identity Resolution Job.
NumberOfProfilesReviewed (integer) --
The number of profiles reviewed.
NumberOfMatchesFound (integer) --
The number of matches found.
NumberOfMergesDone (integer) --
The number of merges completed.
ExportingLocation (dict) --
The S3 location where the Identity Resolution Job writes result files.
S3Exporting (dict) --
Information about the S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket name where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
Message (string) --
The error messages that are generated when the Identity Resolution Job runs.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_integrations(**kwargs)¶Lists all of the integrations in your domain.
See also: AWS API Documentation
Request Syntax
response = client.list_integrations(
DomainName='string',
NextToken='string',
MaxResults=123,
IncludeHidden=True|False
)
[REQUIRED]
The unique name of the domain.
False .dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListIntegrations instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
ObjectTypeNames (dict) --
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 .
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (boolean) --
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
NextToken (string) --
The pagination token from the previous ListIntegrations API call.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_profile_object_type_templates(**kwargs)¶Lists all of the template information for object types.
See also: AWS API Documentation
Request Syntax
response = client.list_profile_object_type_templates(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Items': [
{
'TemplateId': 'string',
'SourceName': 'string',
'SourceObject': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObjectType template instances.
(dict) --
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
TemplateId (string) --
A unique identifier for the object template.
SourceName (string) --
The name of the source of the object template.
SourceObject (string) --
The source of the object template.
NextToken (string) --
The pagination token from the previous ListObjectTypeTemplates API call.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_profile_object_types(**kwargs)¶Lists all of the templates available within the service.
See also: AWS API Documentation
Request Syntax
response = client.list_profile_object_types(
DomainName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObjectTypes instances.
(dict) --
A ProfileObjectType instance.
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
Description of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionlist_profile_objects(**kwargs)¶Returns a list of objects associated with a profile of a given ProfileObjectType.
See also: AWS API Documentation
Request Syntax
response = client.list_profile_objects(
NextToken='string',
MaxResults=123,
DomainName='string',
ObjectTypeName='string',
ProfileId='string',
ObjectFilter={
'KeyName': 'string',
'Values': [
'string',
]
}
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The name of the profile object type.
[REQUIRED]
The unique identifier of a customer profile.
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.
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.
A list of key values.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': 'string',
'ProfileObjectUniqueKey': 'string',
'Object': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObject instances.
(dict) --
A ProfileObject in a list of ProfileObjects.
ObjectTypeName (string) --
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
ProfileObjectUniqueKey (string) --
The unique identifier of the ProfileObject generated by the service.
Object (string) --
A JSON representation of a ProfileObject that belongs to a profile.
NextToken (string) --
The pagination token from the previous call to ListProfileObjects.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource for which you want to view tags.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.InternalServerExceptionCustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionlist_workflows(**kwargs)¶Query to list all workflows.
See also: AWS API Documentation
Request Syntax
response = client.list_workflows(
DomainName='string',
WorkflowType='APPFLOW_INTEGRATION',
Status='NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
QueryStartDate=datetime(2015, 1, 1),
QueryEndDate=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Items': [
{
'WorkflowType': 'APPFLOW_INTEGRATION',
'WorkflowId': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
'StatusDescription': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
List containing workflow details.
(dict) --
A workflow in list of workflows.
WorkflowType (string) --
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
WorkflowId (string) --
Unique identifier for the workflow.
Status (string) --
Status of workflow execution.
StatusDescription (string) --
Description for workflow execution status.
CreatedAt (datetime) --
Creation timestamp for workflow.
LastUpdatedAt (datetime) --
Last updated timestamp for workflow.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionmerge_profiles(**kwargs)¶Runs an AWS Lambda job that does the following:
ProfileToBeMerged will be moved to the main profile.ProfileToBeMerged will be moved to the main profile.ProfileToBeMerged will be deleted at the end.ProfileIdsToBeMerged will be moved to the main profile.SourceProfileIds entry is specified, the main Profile value is always taken.SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
See also: AWS API Documentation
Request Syntax
response = client.merge_profiles(
DomainName='string',
MainProfileId='string',
ProfileIdsToBeMerged=[
'string',
],
FieldSourceProfileIds={
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'string',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'string',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': 'string',
'ShippingAddress': 'string',
'MailingAddress': 'string',
'BillingAddress': 'string',
'Attributes': {
'string': 'string'
}
}
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The identifier of the profile to be taken.
[REQUIRED]
The identifier of the profile to be merged into MainProfileId.
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.
A unique identifier for the account number field to be merged.
A unique identifier for the additional information field to be merged.
A unique identifier for the party type field to be merged.
A unique identifier for the business name field to be merged.
A unique identifier for the first name field to be merged.
A unique identifier for the middle name field to be merged.
A unique identifier for the last name field to be merged.
A unique identifier for the birthdate field to be merged.
A unique identifier for the gender field to be merged.
A unique identifier for the phone number field to be merged.
A unique identifier for the mobile phone number field to be merged.
A unique identifier for the home phone number field to be merged.
A unique identifier for the business phone number field to be merged.
A unique identifier for the email address field to be merged.
A unique identifier for the personal email address field to be merged.
A unique identifier for the party type field to be merged.
A unique identifier for the party type field to be merged.
A unique identifier for the shipping address field to be merged.
A unique identifier for the mailing address field to be merged.
A unique identifier for the billing type field to be merged.
A unique identifier for the attributes field to be merged.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the merge request is complete.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionput_integration(**kwargs)¶Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
See also: AWS API Documentation
Request Syntax
response = client.put_integration(
DomainName='string',
Uri='string',
ObjectTypeName='string',
Tags={
'string': 'string'
},
FlowDefinition={
'Description': 'string',
'FlowName': 'string',
'KmsArn': 'string',
'SourceFlowConfig': {
'ConnectorProfileName': 'string',
'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
'IncrementalPullConfig': {
'DatetimeTypeFieldName': 'string'
},
'SourceConnectorProperties': {
'Marketo': {
'Object': 'string'
},
'S3': {
'BucketName': 'string',
'BucketPrefix': 'string'
},
'Salesforce': {
'Object': 'string',
'EnableDynamicFieldUpdate': True|False,
'IncludeDeletedRecords': True|False
},
'ServiceNow': {
'Object': 'string'
},
'Zendesk': {
'Object': 'string'
}
}
},
'Tasks': [
{
'ConnectorOperator': {
'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
},
'DestinationField': 'string',
'SourceFields': [
'string',
],
'TaskProperties': {
'string': 'string'
},
'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
},
],
'TriggerConfig': {
'TriggerType': 'Scheduled'|'Event'|'OnDemand',
'TriggerProperties': {
'Scheduled': {
'ScheduleExpression': 'string',
'DataPullMode': 'Incremental'|'Complete',
'ScheduleStartTime': datetime(2015, 1, 1),
'ScheduleEndTime': datetime(2015, 1, 1),
'Timezone': 'string',
'ScheduleOffset': 123,
'FirstExecutionFrom': datetime(2015, 1, 1)
}
}
}
},
ObjectTypeNames={
'string': 'string'
}
)
[REQUIRED]
The unique name of the domain.
The tags used to organize, track, or control access for this resource.
The configuration that controls how Customer Profiles retrieves data from the source.
A description of the flow you want to create.
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
The configuration that controls how Customer Profiles retrieves data from the source.
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
The type of connector, such as Salesforce, Marketo, and so on.
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.
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
Specifies the information that is required to query a particular source connector.
The properties that are applied when Marketo is being used as a source.
The object specified in the Marketo flow source.
The properties that are applied when Amazon S3 is being used as the flow source.
The Amazon S3 bucket name where the source files are stored.
The object key for the Amazon S3 bucket in which the source files are stored.
The properties that are applied when Salesforce is being used as a source.
The object specified in the Salesforce flow source.
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Indicates whether Amazon AppFlow includes deleted files in the flow run.
The properties that are applied when ServiceNow is being used as a source.
The object specified in the ServiceNow flow source.
The properties that are applied when using Zendesk as a flow source.
The object specified in the Zendesk flow source.
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
The operation to be performed on the provided source fields.
The operation to be performed on the provided Marketo source fields.
The operation to be performed on the provided Amazon S3 source fields.
The operation to be performed on the provided Salesforce source fields.
The operation to be performed on the provided ServiceNow source fields.
The operation to be performed on the provided Zendesk source fields.
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
The source fields to which a particular task is applied.
A map used to store task-related information. The service looks for particular information based on the TaskType.
Specifies the particular task implementation that Amazon AppFlow performs.
The trigger settings that determine how and when the flow runs.
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow that you define.
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Specifies the scheduled start time for a scheduled-trigger flow.
Specifies the scheduled end time for a scheduled-trigger flow.
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Specifies the date range for the records to import from the connector in the first flow run.
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 .
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
ObjectTypeNames (dict) --
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 .
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (boolean) --
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionput_profile_object(**kwargs)¶Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
See also: AWS API Documentation
Request Syntax
response = client.put_profile_object(
ObjectTypeName='string',
Object='string',
DomainName='string'
)
[REQUIRED]
The name of the profile object type.
[REQUIRED]
A string that is serialized from a JSON object.
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'ProfileObjectUniqueKey': 'string'
}
Response Structure
(dict) --
ProfileObjectUniqueKey (string) --
The unique identifier of the profile object generated by the service.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionput_profile_object_type(**kwargs)¶Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource / UntagResource.
See also: AWS API Documentation
Request Syntax
response = client.put_profile_object_type(
DomainName='string',
ObjectTypeName='string',
Description='string',
TemplateId='string',
ExpirationDays=123,
EncryptionKey='string',
AllowProfileCreation=True|False,
SourceLastUpdatedTimestampFormat='string',
Fields={
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
Keys={
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY'|'ORDER',
],
'FieldNames': [
'string',
]
},
]
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The name of the profile object type.
[REQUIRED]
Description of the profile object type.
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 .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.sourceLastUpdatedTimestamp that was previously set up.A map of the name and ObjectType field.
Represents a field in a ProfileObjectType.
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.
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
The content type of the field. Used for determining equality when searching.
A list of unique keys that can be used to map data to the profile.
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
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.
The reference for the key name of the fields map.
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY'|'ORDER',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
Description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
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.
SourceLastUpdatedTimestampFormat (string) --
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 .
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
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.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
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.
FieldNames (list) --
The reference for the key name of the fields map.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionsearch_profiles(**kwargs)¶Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.
This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.
See also: AWS API Documentation
Request Syntax
response = client.search_profiles(
NextToken='string',
MaxResults=123,
DomainName='string',
KeyName='string',
Values=[
'string',
],
AdditionalSearchKeys=[
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
LogicalOperator='AND'|'OR'
)
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
[REQUIRED]
The unique name of the domain.
[REQUIRED]
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.
[REQUIRED]
A list of key values.
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.
A data type pair that consists of a KeyName and Values list that is used in conjunction with the KeyName and Values parameters to search for profiles using the SearchProfiles API.
A searchable identifier of a customer profile.
A list of key values.
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.
dict
Response Syntax
{
'Items': [
{
'ProfileId': 'string',
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'ShippingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'MailingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'BillingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'Attributes': {
'string': 'string'
},
'FoundByItems': [
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
'PartyTypeString': 'string',
'GenderString': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of Profiles matching the search criteria.
(dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
A unique account number that you have given to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer’s profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer’s email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
FoundByItems (list) --
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.
(dict) --
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
PartyTypeString (string) --
An alternative to PartyType which accepts any string as input.
GenderString (string) --
An alternative to Gender which accepts any string as input.
NextToken (string) --
The pagination token from the previous SearchProfiles API call.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource that you're adding tags to.
[REQUIRED]
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CustomerProfiles.Client.exceptions.InternalServerExceptionCustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource from which you are removing tags.
[REQUIRED]
The list of tag keys to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CustomerProfiles.Client.exceptions.InternalServerExceptionCustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionupdate_domain(**kwargs)¶Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to enable identity resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource / UntagResource.
See also: AWS API Documentation
Request Syntax
response = client.update_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The unique name of the domain.
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.
The flag that enables the matching process of duplicate profiles.
The day and time when do you want to start the Identity Resolution Job every week.
The day when the Identity Resolution Job should run every week.
The time when the Identity Resolution Job should run every week.
Configuration information about the auto-merging process.
The flag that enables the auto-merging of duplicate profiles.
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.
A list of matching criteria.
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?
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.The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
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.
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
The S3 location where Identity Resolution Jobs write result files.
The name of the S3 bucket where Identity Resolution Jobs write result files.
The S3 key name of the location where Identity Resolution Jobs write result files.
The tags used to organize, track, or control access for this resource.
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
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.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
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.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
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.SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
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.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionupdate_profile(**kwargs)¶Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
See also: AWS API Documentation
Request Syntax
response = client.update_profile(
DomainName='string',
ProfileId='string',
AdditionalInformation='string',
AccountNumber='string',
PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
BusinessName='string',
FirstName='string',
MiddleName='string',
LastName='string',
BirthDate='string',
Gender='MALE'|'FEMALE'|'UNSPECIFIED',
PhoneNumber='string',
MobilePhoneNumber='string',
HomePhoneNumber='string',
BusinessPhoneNumber='string',
EmailAddress='string',
PersonalEmailAddress='string',
BusinessEmailAddress='string',
Address={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
ShippingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
MailingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
BillingAddress={
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
Attributes={
'string': 'string'
},
PartyTypeString='string',
GenderString='string'
)
[REQUIRED]
The unique name of the domain.
[REQUIRED]
The unique identifier of a customer profile.
A generic address associated with the customer that is not mailing, shipping, or billing.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s shipping address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s mailing address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
The customer’s billing address.
The first line of a customer address.
The second line of a customer address.
The third line of a customer address.
The fourth line of a customer address.
The city in which a customer lives.
The county in which a customer lives.
The state in which a customer lives.
The province in which a customer lives.
The country in which a customer lives.
The postal code of a customer address.
A key value pair of attributes of a customer profile.
PartyType which accepts any string as input.Gender which accepts any string as input.dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestExceptionCustomerProfiles.Client.exceptions.AccessDeniedExceptionCustomerProfiles.Client.exceptions.ResourceNotFoundExceptionCustomerProfiles.Client.exceptions.ThrottlingExceptionCustomerProfiles.Client.exceptions.InternalServerExceptionThe available paginators are: