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.
For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles
in the Amazon Connect Administrator's Guide.
customerprofiles( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
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.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
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.
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",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_profile_key | Associates a new key value with a specific profile, such as a Contact Record ContactId |
| batch_get_calculated_attribute_for_profile | Fetch the possible attribute values given the attribute name |
| batch_get_profile | Get a batch of profiles |
| create_calculated_attribute_definition | Creates a new calculated attribute definition |
| 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_event_stream | Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles |
| create_event_trigger | Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data |
| create_integration_workflow | Creates an integration workflow |
| create_profile | Creates a standard profile |
| create_segment_definition | Creates a segment definition associated to the given domain |
| create_segment_estimate | Creates a segment estimate query |
| create_segment_snapshot | Triggers a job to export a segment to a specified destination |
| delete_calculated_attribute_definition | Deletes an existing calculated attribute definition |
| delete_domain | Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects |
| delete_event_stream | Disables and deletes the specified event stream |
| delete_event_trigger | Disable and deletes the Event Trigger |
| 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_segment_definition | Deletes a segment definition from the domain |
| delete_workflow | Deletes the specified workflow and all its corresponding resources |
| detect_profile_object_type | The process of detecting profile object type mapping by using given objects |
| get_auto_merging_preview | Tests the auto-merging settings of your Identity Resolution Job without merging your data |
| get_calculated_attribute_definition | Provides more information on a calculated attribute definition for Customer Profiles |
| get_calculated_attribute_for_profile | Retrieve a calculated attribute for a customer profile |
| get_domain | Returns information about a specific domain |
| get_event_stream | Returns information about the specified event stream in a specific domain |
| get_event_trigger | Get a specific Event Trigger from the 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_segment_definition | Gets a segment definition from the domain |
| get_segment_estimate | Gets the result of a segment estimate query |
| get_segment_membership | Determines if the given profiles are within a segment |
| get_segment_snapshot | Retrieve the latest status of a segment snapshot |
| get_similar_profiles | Returns a set of profiles that belong to the same matching group using the matchId or profileId |
| 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_calculated_attribute_definitions | Lists calculated attribute definitions for Customer Profiles |
| list_calculated_attributes_for_profile | Retrieve a list of calculated attributes for a customer profile |
| list_domains | Returns a list of all the domains for an AWS account that have been created |
| list_event_streams | Returns a list of all the event streams in a specific domain |
| list_event_triggers | List all Event Triggers under a domain |
| 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_object_type_attributes | Fetch the possible attribute values given the attribute name |
| list_profile_attribute_values | Fetch the possible attribute values given the attribute name |
| 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_rule_based_matches | Returns a set of MatchIds that belong to the given domain |
| list_segment_definitions | Lists all segment definitions under a domain |
| 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 using one or more predefined search keys (e |
| 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_calculated_attribute_definition | Updates an existing calculated attribute definition |
| update_domain | Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key |
| update_event_trigger | Update the properties of an Event Trigger |
| update_profile | Updates the properties of a profile |
## Not run: svc <- customerprofiles() svc$add_profile_key( Foo = 123 ) ## End(Not run)
Useful links
Downloads (last 30 days):