Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.
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 also review the Amazon Connect Administrator Guide.
customerprofiles(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- customerprofiles(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| add_profile_key | Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId |
| create_domain | Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys |
| create_integration_workflow | Creates an integration workflow |
| create_profile | Creates a standard profile |
| delete_domain | Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects |
| delete_integration | Removes an integration from a specific domain |
| delete_profile | Deletes the standard customer profile and all data pertaining to the profile |
| delete_profile_key | Removes a searchable key from a customer profile |
| delete_profile_object | Removes an object associated with a profile of a given ProfileObjectType |
| delete_profile_object_type | Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type |
| delete_workflow | Deletes the specified workflow and all its corresponding resources |
| get_auto_merging_preview | Tests the auto-merging settings of your Identity Resolution Job without merging your data |
| get_domain | Returns information about a specific domain |
| get_identity_resolution_job | Returns information about an Identity Resolution Job in a specific domain |
| get_integration | Returns an integration for a domain |
| get_matches | Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true |
| get_profile_object_type | Returns the object types for a specific domain |
| get_profile_object_type_template | Returns the template information for a specific object type |
| get_workflow | Get details of specified workflow |
| get_workflow_steps | Get granular list of steps in workflow |
| list_account_integrations | Lists all of the integrations associated to a specific URI in the AWS account |
| list_domains | Returns a list of all the domains for an AWS account that have been created |
| list_identity_resolution_jobs | Lists all of the Identity Resolution Jobs in your domain |
| list_integrations | Lists all of the integrations in your domain |
| list_profile_objects | Returns a list of objects associated with a profile of a given ProfileObjectType |
| list_profile_object_types | Lists all of the templates available within the service |
| list_profile_object_type_templates | Lists all of the template information for object types |
| list_tags_for_resource | Displays the tags associated with an Amazon Connect Customer Profiles resource |
| list_workflows | Query to list all workflows |
| merge_profiles | Runs an AWS Lambda job that does the following: |
| put_integration | Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect |
| put_profile_object | Adds additional objects to customer profiles of a given ObjectType |
| put_profile_object_type | Defines a ProfileObjectType |
| search_profiles | Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index |
| tag_resource | Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource |
| untag_resource | Removes one or more tags from the specified Amazon Connect Customer Profiles resource |
| update_domain | Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key |
| update_profile | Updates the properties of a profile |
if (FALSE) {
svc <- customerprofiles()
svc$add_profile_key(
Foo = 123
)
}
Run the code above in your browser using DataLab