Class: Aws::CustomerProfiles::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CustomerProfiles::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb
Overview
An API client for CustomerProfiles. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CustomerProfiles::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_profile_key(params = {}) ⇒ Types::AddProfileKeyResponse
Associates a new key value with a specific profile, such as a Contact Record ContactId.
-
#create_calculated_attribute_definition(params = {}) ⇒ Types::CreateCalculatedAttributeDefinitionResponse
Creates a new calculated attribute definition.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
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(params = {}) ⇒ Types::CreateEventStreamResponse
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_integration_workflow(params = {}) ⇒ Types::CreateIntegrationWorkflowResponse
Creates an integration workflow.
-
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a standard profile.
-
#delete_calculated_attribute_definition(params = {}) ⇒ Struct
Deletes an existing calculated attribute definition.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
-
#delete_event_stream(params = {}) ⇒ Struct
Disables and deletes the specified event stream.
-
#delete_integration(params = {}) ⇒ Types::DeleteIntegrationResponse
Removes an integration from a specific domain.
-
#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse
Deletes the standard customer profile and all data pertaining to the profile.
-
#delete_profile_key(params = {}) ⇒ Types::DeleteProfileKeyResponse
Removes a searchable key from a customer profile.
-
#delete_profile_object(params = {}) ⇒ Types::DeleteProfileObjectResponse
Removes an object associated with a profile of a given ProfileObjectType.
-
#delete_profile_object_type(params = {}) ⇒ Types::DeleteProfileObjectTypeResponse
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
-
#delete_workflow(params = {}) ⇒ Struct
Deletes the specified workflow and all its corresponding resources.
-
#detect_profile_object_type(params = {}) ⇒ Types::DetectProfileObjectTypeResponse
The process of detecting profile object type mapping by using given objects.
-
#get_auto_merging_preview(params = {}) ⇒ Types::GetAutoMergingPreviewResponse
Tests the auto-merging settings of your Identity Resolution Job without merging your data.
-
#get_calculated_attribute_definition(params = {}) ⇒ Types::GetCalculatedAttributeDefinitionResponse
Provides more information on a calculated attribute definition for Customer Profiles.
-
#get_calculated_attribute_for_profile(params = {}) ⇒ Types::GetCalculatedAttributeForProfileResponse
Retrieve a calculated attribute for a customer profile.
-
#get_domain(params = {}) ⇒ Types::GetDomainResponse
Returns information about a specific domain.
-
#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse
Returns information about the specified event stream in a specific domain.
-
#get_identity_resolution_job(params = {}) ⇒ Types::GetIdentityResolutionJobResponse
Returns information about an Identity Resolution Job in a specific domain.
-
#get_integration(params = {}) ⇒ Types::GetIntegrationResponse
Returns an integration for a domain.
-
#get_matches(params = {}) ⇒ Types::GetMatchesResponse
Before calling this API, use [CreateDomain][1] or [UpdateDomain][2] to enable identity resolution: set
Matching
to true. -
#get_profile_object_type(params = {}) ⇒ Types::GetProfileObjectTypeResponse
Returns the object types for a specific domain.
-
#get_profile_object_type_template(params = {}) ⇒ Types::GetProfileObjectTypeTemplateResponse
Returns the template information for a specific object type.
-
#get_similar_profiles(params = {}) ⇒ Types::GetSimilarProfilesResponse
Returns a set of profiles that belong to the same matching group using the
matchId
orprofileId
. -
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Get details of specified workflow.
-
#get_workflow_steps(params = {}) ⇒ Types::GetWorkflowStepsResponse
Get granular list of steps in workflow.
-
#list_account_integrations(params = {}) ⇒ Types::ListAccountIntegrationsResponse
Lists all of the integrations associated to a specific URI in the AWS account.
-
#list_calculated_attribute_definitions(params = {}) ⇒ Types::ListCalculatedAttributeDefinitionsResponse
Lists calculated attribute definitions for Customer Profiles.
-
#list_calculated_attributes_for_profile(params = {}) ⇒ Types::ListCalculatedAttributesForProfileResponse
Retrieve a list of calculated attributes for a customer profile.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Returns a list of all the domains for an AWS account that have been created.
-
#list_event_streams(params = {}) ⇒ Types::ListEventStreamsResponse
Returns a list of all the event streams in a specific domain.
-
#list_identity_resolution_jobs(params = {}) ⇒ Types::ListIdentityResolutionJobsResponse
Lists all of the Identity Resolution Jobs in your domain.
-
#list_integrations(params = {}) ⇒ Types::ListIntegrationsResponse
Lists all of the integrations in your domain.
-
#list_profile_object_type_templates(params = {}) ⇒ Types::ListProfileObjectTypeTemplatesResponse
Lists all of the template information for object types.
-
#list_profile_object_types(params = {}) ⇒ Types::ListProfileObjectTypesResponse
Lists all of the templates available within the service.
-
#list_profile_objects(params = {}) ⇒ Types::ListProfileObjectsResponse
Returns a list of objects associated with a profile of a given ProfileObjectType.
-
#list_rule_based_matches(params = {}) ⇒ Types::ListRuleBasedMatchesResponse
Returns a set of
MatchIds
that belong to the given domain. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with an Amazon Connect Customer Profiles resource.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Query to list all workflows.
-
#merge_profiles(params = {}) ⇒ Types::MergeProfilesResponse
Runs an AWS Lambda job that does the following:.
-
#put_integration(params = {}) ⇒ Types::PutIntegrationResponse
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
-
#put_profile_object(params = {}) ⇒ Types::PutProfileObjectResponse
Adds additional objects to customer profiles of a given ObjectType.
-
#put_profile_object_type(params = {}) ⇒ Types::PutProfileObjectTypeResponse
Defines a ProfileObjectType.
-
#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse
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.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
-
#update_calculated_attribute_definition(params = {}) ⇒ Types::UpdateCalculatedAttributeDefinitionResponse
Updates an existing calculated attribute definition.
-
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
-
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
Updates the properties of a profile.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#add_profile_key(params = {}) ⇒ Types::AddProfileKeyResponse
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.
440 441 442 443 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 440 def add_profile_key(params = {}, = {}) req = build_request(:add_profile_key, params) req.send_request() end |
#create_calculated_attribute_definition(params = {}) ⇒ Types::CreateCalculatedAttributeDefinitionResponse
Creates a new calculated attribute definition. After creation, new
object data ingested into Customer Profiles will be included in the
calculated attribute, which can be retrieved for a profile using the
GetCalculatedAttributeForProfile API. Defining a calculated
attribute makes it available for all profiles within a domain. Each
calculated attribute can only reference one ObjectType
and at most,
two fields from that ObjectType
.
550 551 552 553 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 550 def create_calculated_attribute_definition(params = {}, = {}) req = build_request(:create_calculated_attribute_definition, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
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.
743 744 745 746 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 743 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_event_stream(params = {}) ⇒ Types::CreateEventStreamResponse
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.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
795 796 797 798 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 795 def create_event_stream(params = {}, = {}) req = build_request(:create_event_stream, params) req.send_request() end |
#create_integration_workflow(params = {}) ⇒ Types::CreateIntegrationWorkflowResponse
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.
925 926 927 928 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 925 def create_integration_workflow(params = {}, = {}) req = build_request(:create_integration_workflow, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1097 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#delete_calculated_attribute_definition(params = {}) ⇒ Struct
Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1127 def delete_calculated_attribute_definition(params = {}, = {}) req = build_request(:delete_calculated_attribute_definition, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1156 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_event_stream(params = {}) ⇒ Struct
Disables and deletes the specified event stream.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1182 def delete_event_stream(params = {}, = {}) req = build_request(:delete_event_stream, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Types::DeleteIntegrationResponse
Removes an integration from a specific domain.
1214 1215 1216 1217 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1214 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse
Deletes the standard customer profile and all data pertaining to the profile.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1247 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_profile_key(params = {}) ⇒ Types::DeleteProfileKeyResponse
Removes a searchable key from a customer profile.
1287 1288 1289 1290 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1287 def delete_profile_key(params = {}, = {}) req = build_request(:delete_profile_key, params) req.send_request() end |
#delete_profile_object(params = {}) ⇒ Types::DeleteProfileObjectResponse
Removes an object associated with a profile of a given ProfileObjectType.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1328 def delete_profile_object(params = {}, = {}) req = build_request(:delete_profile_object, params) req.send_request() end |
#delete_profile_object_type(params = {}) ⇒ Types::DeleteProfileObjectTypeResponse
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.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1364 def delete_profile_object_type(params = {}, = {}) req = build_request(:delete_profile_object_type, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes the specified workflow and all its corresponding resources. This is an async process.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1391 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#detect_profile_object_type(params = {}) ⇒ Types::DetectProfileObjectTypeResponse
The process of detecting profile object type mapping by using given objects.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1435 def detect_profile_object_type(params = {}, = {}) req = build_request(:detect_profile_object_type, params) req.send_request() end |
#get_auto_merging_preview(params = {}) ⇒ Types::GetAutoMergingPreviewResponse
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.
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.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1505 def get_auto_merging_preview(params = {}, = {}) req = build_request(:get_auto_merging_preview, params) req.send_request() end |
#get_calculated_attribute_definition(params = {}) ⇒ Types::GetCalculatedAttributeDefinitionResponse
Provides more information on a calculated attribute definition for Customer Profiles.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1561 def get_calculated_attribute_definition(params = {}, = {}) req = build_request(:get_calculated_attribute_definition, params) req.send_request() end |
#get_calculated_attribute_for_profile(params = {}) ⇒ Types::GetCalculatedAttributeForProfileResponse
Retrieve a calculated attribute for a customer profile.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1603 def get_calculated_attribute_for_profile(params = {}, = {}) req = build_request(:get_calculated_attribute_for_profile, params) req.send_request() end |
#get_domain(params = {}) ⇒ Types::GetDomainResponse
Returns information about a specific domain.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1681 def get_domain(params = {}, = {}) req = build_request(:get_domain, params) req.send_request() end |
#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse
Returns information about the specified event stream in a specific domain.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1730 def get_event_stream(params = {}, = {}) req = build_request(:get_event_stream, params) req.send_request() end |
#get_identity_resolution_job(params = {}) ⇒ Types::GetIdentityResolutionJobResponse
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.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1800 def get_identity_resolution_job(params = {}, = {}) req = build_request(:get_identity_resolution_job, params) req.send_request() end |
#get_integration(params = {}) ⇒ Types::GetIntegrationResponse
Returns an integration for a domain.
1850 1851 1852 1853 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1850 def get_integration(params = {}, = {}) req = build_request(:get_integration, params) req.send_request() end |
#get_matches(params = {}) ⇒ Types::GetMatchesResponse
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.
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:
PhoneNumber
HomePhoneNumber
BusinessPhoneNumber
MobilePhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
FullName
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.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1945 def get_matches(params = {}, = {}) req = build_request(:get_matches, params) req.send_request() end |
#get_profile_object_type(params = {}) ⇒ Types::GetProfileObjectTypeResponse
Returns the object types for a specific domain.
2008 2009 2010 2011 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2008 def get_profile_object_type(params = {}, = {}) req = build_request(:get_profile_object_type, params) req.send_request() end |
#get_profile_object_type_template(params = {}) ⇒ Types::GetProfileObjectTypeTemplateResponse
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.
2062 2063 2064 2065 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2062 def get_profile_object_type_template(params = {}, = {}) req = build_request(:get_profile_object_type_template, params) req.send_request() end |
#get_similar_profiles(params = {}) ⇒ Types::GetSimilarProfilesResponse
Returns a set of profiles that belong to the same matching group using
the matchId
or profileId
. You can also specify the type of
matching that you want for finding similar profiles using either
RULE_BASED_MATCHING
or ML_BASED_MATCHING
.
2124 2125 2126 2127 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2124 def get_similar_profiles(params = {}, = {}) req = build_request(:get_similar_profiles, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Get details of specified workflow.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2174 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#get_workflow_steps(params = {}) ⇒ Types::GetWorkflowStepsResponse
Get granular list of steps in workflow.
2230 2231 2232 2233 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2230 def get_workflow_steps(params = {}, = {}) req = build_request(:get_workflow_steps, params) req.send_request() end |
#list_account_integrations(params = {}) ⇒ Types::ListAccountIntegrationsResponse
Lists all of the integrations associated to a specific URI in the AWS account.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2286 def list_account_integrations(params = {}, = {}) req = build_request(:list_account_integrations, params) req.send_request() end |
#list_calculated_attribute_definitions(params = {}) ⇒ Types::ListCalculatedAttributeDefinitionsResponse
Lists calculated attribute definitions for Customer Profiles
2333 2334 2335 2336 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2333 def list_calculated_attribute_definitions(params = {}, = {}) req = build_request(:list_calculated_attribute_definitions, params) req.send_request() end |
#list_calculated_attributes_for_profile(params = {}) ⇒ Types::ListCalculatedAttributesForProfileResponse
Retrieve a list of calculated attributes for a customer profile.
2380 2381 2382 2383 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2380 def list_calculated_attributes_for_profile(params = {}, = {}) req = build_request(:list_calculated_attributes_for_profile, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Returns a list of all the domains for an AWS account that have been created.
2420 2421 2422 2423 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2420 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_event_streams(params = {}) ⇒ Types::ListEventStreamsResponse
Returns a list of all the event streams in a specific domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2470 def list_event_streams(params = {}, = {}) req = build_request(:list_event_streams, params) req.send_request() end |
#list_identity_resolution_jobs(params = {}) ⇒ Types::ListIdentityResolutionJobsResponse
Lists all of the Identity Resolution Jobs in your domain. The response
sorts the list by JobStartTime
.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2522 def list_identity_resolution_jobs(params = {}, = {}) req = build_request(:list_identity_resolution_jobs, params) req.send_request() end |
#list_integrations(params = {}) ⇒ Types::ListIntegrationsResponse
Lists all of the integrations in your domain.
2576 2577 2578 2579 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2576 def list_integrations(params = {}, = {}) req = build_request(:list_integrations, params) req.send_request() end |
#list_profile_object_type_templates(params = {}) ⇒ Types::ListProfileObjectTypeTemplatesResponse
Lists all of the template information for object types.
2614 2615 2616 2617 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2614 def list_profile_object_type_templates(params = {}, = {}) req = build_request(:list_profile_object_type_templates, params) req.send_request() end |
#list_profile_object_types(params = {}) ⇒ Types::ListProfileObjectTypesResponse
Lists all of the templates available within the service.
2658 2659 2660 2661 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2658 def list_profile_object_types(params = {}, = {}) req = build_request(:list_profile_object_types, params) req.send_request() end |
#list_profile_objects(params = {}) ⇒ Types::ListProfileObjectsResponse
Returns a list of objects associated with a profile of a given ProfileObjectType.
2716 2717 2718 2719 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2716 def list_profile_objects(params = {}, = {}) req = build_request(:list_profile_objects, params) req.send_request() end |
#list_rule_based_matches(params = {}) ⇒ Types::ListRuleBasedMatchesResponse
Returns a set of MatchIds
that belong to the given domain.
2756 2757 2758 2759 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2756 def list_rule_based_matches(params = {}, = {}) req = build_request(:list_rule_based_matches, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
2787 2788 2789 2790 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2787 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Query to list all workflows.
2850 2851 2852 2853 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2850 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#merge_profiles(params = {}) ⇒ Types::MergeProfilesResponse
Runs an AWS Lambda job that does the following:
All the profileKeys in the
ProfileToBeMerged
will be moved to the main profile.All the objects in the
ProfileToBeMerged
will be moved to the main profile.All the
ProfileToBeMerged
will be deleted at the end.All the profileKeys in the
ProfileIdsToBeMerged
will be moved to the main profile.Standard fields are merged as follows:
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
When there are conflicting fields:
If no
SourceProfileIds
entry is specified, the main Profile value is always taken.If a
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).
2950 2951 2952 2953 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2950 def merge_profiles(params = {}, = {}) req = build_request(:merge_profiles, params) req.send_request() end |
#put_integration(params = {}) ⇒ Types::PutIntegrationResponse
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.
3100 3101 3102 3103 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3100 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_profile_object(params = {}) ⇒ Types::PutProfileObjectResponse
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.
3149 3150 3151 3152 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3149 def put_profile_object(params = {}, = {}) req = build_request(:put_profile_object, params) req.send_request() end |
#put_profile_object_type(params = {}) ⇒ Types::PutProfileObjectTypeResponse
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3285 def put_profile_object_type(params = {}, = {}) req = build_request(:put_profile_object_type, params) req.send_request() end |
#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse
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.
3445 3446 3447 3448 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3445 def search_profiles(params = {}, = {}) req = build_request(:search_profiles, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
3489 3490 3491 3492 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3489 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3517 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_calculated_attribute_definition(params = {}) ⇒ Types::UpdateCalculatedAttributeDefinitionResponse
Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
3598 3599 3600 3601 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3598 def update_calculated_attribute_definition(params = {}, = {}) req = build_request(:update_calculated_attribute_definition, params) req.send_request() end |
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
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.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3795 def update_domain(params = {}, = {}) req = build_request(:update_domain, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
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.
3973 3974 3975 3976 |
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3973 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |