/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the customer-profiles-2020-08-15.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.CustomerProfiles.Model; namespace Amazon.CustomerProfiles { /// /// Interface for accessing CustomerProfiles /// /// 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. /// /// public partial interface IAmazonCustomerProfiles : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ICustomerProfilesPaginatorFactory Paginators { get; } #endif #region AddProfileKey /// /// 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. /// /// /// Container for the necessary parameters to execute the AddProfileKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddProfileKey service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for AddProfileKey Operation Task AddProfileKeyAsync(AddProfileKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCalculatedAttributeDefinition /// /// 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. /// /// Container for the necessary parameters to execute the CreateCalculatedAttributeDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCalculatedAttributeDefinition service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for CreateCalculatedAttributeDefinition Operation Task CreateCalculatedAttributeDefinitionAsync(CreateCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDomain /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateDomain service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDomain service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for CreateDomain Operation Task CreateDomainAsync(CreateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateEventStream /// /// 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 /// /// /// Container for the necessary parameters to execute the CreateEventStream service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateEventStream service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for CreateEventStream Operation Task CreateEventStreamAsync(CreateEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateIntegrationWorkflow /// /// 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. /// /// Container for the necessary parameters to execute the CreateIntegrationWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateIntegrationWorkflow service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for CreateIntegrationWorkflow Operation Task CreateIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateProfile /// /// Creates a standard profile. /// /// /// /// A standard profile represents the following attributes for a customer profile in a /// domain. /// /// /// Container for the necessary parameters to execute the CreateProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateProfile service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for CreateProfile Operation Task CreateProfileAsync(CreateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCalculatedAttributeDefinition /// /// 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. /// /// Container for the necessary parameters to execute the DeleteCalculatedAttributeDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCalculatedAttributeDefinition service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteCalculatedAttributeDefinition Operation Task DeleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDomain /// /// Deletes a specific domain and all of its customer data, such as customer profile attributes /// and their related objects. /// /// Container for the necessary parameters to execute the DeleteDomain service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDomain service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteDomain Operation Task DeleteDomainAsync(DeleteDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteEventStream /// /// Disables and deletes the specified event stream. /// /// Container for the necessary parameters to execute the DeleteEventStream service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteEventStream service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteEventStream Operation Task DeleteEventStreamAsync(DeleteEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteIntegration /// /// Removes an integration from a specific domain. /// /// Container for the necessary parameters to execute the DeleteIntegration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteIntegration service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteIntegration Operation Task DeleteIntegrationAsync(DeleteIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProfile /// /// Deletes the standard customer profile and all data pertaining to the profile. /// /// Container for the necessary parameters to execute the DeleteProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteProfile service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteProfile Operation Task DeleteProfileAsync(DeleteProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProfileKey /// /// Removes a searchable key from a customer profile. /// /// Container for the necessary parameters to execute the DeleteProfileKey service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteProfileKey service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteProfileKey Operation Task DeleteProfileKeyAsync(DeleteProfileKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProfileObject /// /// Removes an object associated with a profile of a given ProfileObjectType. /// /// Container for the necessary parameters to execute the DeleteProfileObject service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteProfileObject service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteProfileObject Operation Task DeleteProfileObjectAsync(DeleteProfileObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProfileObjectType /// /// 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. /// /// Container for the necessary parameters to execute the DeleteProfileObjectType service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteProfileObjectType service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteProfileObjectType Operation Task DeleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteWorkflow /// /// Deletes the specified workflow and all its corresponding resources. This is an async /// process. /// /// Container for the necessary parameters to execute the DeleteWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteWorkflow service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for DeleteWorkflow Operation Task DeleteWorkflowAsync(DeleteWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetAutoMergingPreview /// /// 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. /// /// /// /// Container for the necessary parameters to execute the GetAutoMergingPreview service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetAutoMergingPreview service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetAutoMergingPreview Operation Task GetAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCalculatedAttributeDefinition /// /// Provides more information on a calculated attribute definition for Customer Profiles. /// /// Container for the necessary parameters to execute the GetCalculatedAttributeDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCalculatedAttributeDefinition service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetCalculatedAttributeDefinition Operation Task GetCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCalculatedAttributeForProfile /// /// Retrieve a calculated attribute for a customer profile. /// /// Container for the necessary parameters to execute the GetCalculatedAttributeForProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCalculatedAttributeForProfile service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetCalculatedAttributeForProfile Operation Task GetCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDomain /// /// Returns information about a specific domain. /// /// Container for the necessary parameters to execute the GetDomain service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDomain service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetDomain Operation Task GetDomainAsync(GetDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetEventStream /// /// Returns information about the specified event stream in a specific domain. /// /// Container for the necessary parameters to execute the GetEventStream service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetEventStream service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetEventStream Operation Task GetEventStreamAsync(GetEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetIdentityResolutionJob /// /// 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. /// /// /// Container for the necessary parameters to execute the GetIdentityResolutionJob service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetIdentityResolutionJob service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetIdentityResolutionJob Operation Task GetIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetIntegration /// /// Returns an integration for a domain. /// /// Container for the necessary parameters to execute the GetIntegration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetIntegration service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetIntegration Operation Task GetIntegrationAsync(GetIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetMatches /// /// 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. /// /// /// Container for the necessary parameters to execute the GetMatches service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetMatches service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetMatches Operation Task GetMatchesAsync(GetMatchesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetProfileObjectType /// /// Returns the object types for a specific domain. /// /// Container for the necessary parameters to execute the GetProfileObjectType service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetProfileObjectType service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetProfileObjectType Operation Task GetProfileObjectTypeAsync(GetProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetProfileObjectTypeTemplate /// /// 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. /// /// /// Container for the necessary parameters to execute the GetProfileObjectTypeTemplate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetProfileObjectTypeTemplate service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetProfileObjectTypeTemplate Operation Task GetProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetSimilarProfiles /// /// 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. /// /// Container for the necessary parameters to execute the GetSimilarProfiles service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetSimilarProfiles service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetSimilarProfiles Operation Task GetSimilarProfilesAsync(GetSimilarProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetWorkflow /// /// Get details of specified workflow. /// /// Container for the necessary parameters to execute the GetWorkflow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetWorkflow service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetWorkflow Operation Task GetWorkflowAsync(GetWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetWorkflowSteps /// /// Get granular list of steps in workflow. /// /// Container for the necessary parameters to execute the GetWorkflowSteps service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetWorkflowSteps service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for GetWorkflowSteps Operation Task GetWorkflowStepsAsync(GetWorkflowStepsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAccountIntegrations /// /// Lists all of the integrations associated to a specific URI in the AWS account. /// /// Container for the necessary parameters to execute the ListAccountIntegrations service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAccountIntegrations service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListAccountIntegrations Operation Task ListAccountIntegrationsAsync(ListAccountIntegrationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListCalculatedAttributeDefinitions /// /// Lists calculated attribute definitions for Customer Profiles /// /// Container for the necessary parameters to execute the ListCalculatedAttributeDefinitions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListCalculatedAttributeDefinitions service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListCalculatedAttributeDefinitions Operation Task ListCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListCalculatedAttributesForProfile /// /// Retrieve a list of calculated attributes for a customer profile. /// /// Container for the necessary parameters to execute the ListCalculatedAttributesForProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListCalculatedAttributesForProfile service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListCalculatedAttributesForProfile Operation Task ListCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListDomains /// /// Returns a list of all the domains for an AWS account that have been created. /// /// Container for the necessary parameters to execute the ListDomains service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListDomains service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListDomains Operation Task ListDomainsAsync(ListDomainsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListEventStreams /// /// Returns a list of all the event streams in a specific domain. /// /// Container for the necessary parameters to execute the ListEventStreams service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListEventStreams service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListEventStreams Operation Task ListEventStreamsAsync(ListEventStreamsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListIdentityResolutionJobs /// /// Lists all of the Identity Resolution Jobs in your domain. The response sorts the list /// by JobStartTime. /// /// Container for the necessary parameters to execute the ListIdentityResolutionJobs service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListIdentityResolutionJobs service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListIdentityResolutionJobs Operation Task ListIdentityResolutionJobsAsync(ListIdentityResolutionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListIntegrations /// /// Lists all of the integrations in your domain. /// /// Container for the necessary parameters to execute the ListIntegrations service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListIntegrations service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListIntegrations Operation Task ListIntegrationsAsync(ListIntegrationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListProfileObjects /// /// Returns a list of objects associated with a profile of a given ProfileObjectType. /// /// Container for the necessary parameters to execute the ListProfileObjects service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListProfileObjects service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListProfileObjects Operation Task ListProfileObjectsAsync(ListProfileObjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListProfileObjectTypes /// /// Lists all of the templates available within the service. /// /// Container for the necessary parameters to execute the ListProfileObjectTypes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListProfileObjectTypes service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListProfileObjectTypes Operation Task ListProfileObjectTypesAsync(ListProfileObjectTypesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListProfileObjectTypeTemplates /// /// Lists all of the template information for object types. /// /// Container for the necessary parameters to execute the ListProfileObjectTypeTemplates service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListProfileObjectTypeTemplates service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListProfileObjectTypeTemplates Operation Task ListProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListRuleBasedMatches /// /// Returns a set of MatchIds that belong to the given domain. /// /// Container for the necessary parameters to execute the ListRuleBasedMatches service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListRuleBasedMatches service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListRuleBasedMatches Operation Task ListRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Displays the tags associated with an Amazon Connect Customer Profiles resource. In /// Connect Customer Profiles, domains, profile object types, and integrations can be /// tagged. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by CustomerProfiles. /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListWorkflows /// /// Query to list all workflows. /// /// Container for the necessary parameters to execute the ListWorkflows service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListWorkflows service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for ListWorkflows Operation Task ListWorkflowsAsync(ListWorkflowsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region MergeProfiles /// /// Runs an AWS Lambda job that does the following: /// ///
  1. /// /// All the profileKeys in the ProfileToBeMerged will be moved to the main /// profile. /// ///
  2. /// /// All the objects in the ProfileToBeMerged will be moved to the main profile. /// ///
  3. /// /// All the ProfileToBeMerged will be deleted at the end. /// ///
  4. /// /// All the profileKeys in the ProfileIdsToBeMerged will be moved to the /// main profile. /// ///
  5. /// /// Standard fields are merged as follows: /// ///
    1. /// /// Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. /// ///
    2. /// /// When there are conflicting fields: /// ///
      1. /// /// If no SourceProfileIds entry is specified, the main Profile value is /// always taken. /// ///
      2. /// /// 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). /// /// /// Container for the necessary parameters to execute the MergeProfiles service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the MergeProfiles service method, as returned by CustomerProfiles. /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for MergeProfiles Operation Task MergeProfilesAsync(MergeProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutIntegration /// /// 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. /// /// /// Container for the necessary parameters to execute the PutIntegration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutIntegration service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for PutIntegration Operation Task PutIntegrationAsync(PutIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutProfileObject /// /// 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. /// /// /// Container for the necessary parameters to execute the PutProfileObject service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutProfileObject service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for PutProfileObject Operation Task PutProfileObjectAsync(PutProfileObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutProfileObjectType /// /// Defines a ProfileObjectType. /// /// /// /// To add or remove tags on an existing ObjectType, see /// TagResource/UntagResource. /// /// /// Container for the necessary parameters to execute the PutProfileObjectType service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutProfileObjectType service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for PutProfileObjectType Operation Task PutProfileObjectTypeAsync(PutProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SearchProfiles /// /// 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. /// /// /// Container for the necessary parameters to execute the SearchProfiles service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SearchProfiles service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for SearchProfiles Operation Task SearchProfilesAsync(SearchProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// 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. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by CustomerProfiles. /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// 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. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by CustomerProfiles. /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateCalculatedAttributeDefinition /// /// 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. /// /// Container for the necessary parameters to execute the UpdateCalculatedAttributeDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCalculatedAttributeDefinition service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for UpdateCalculatedAttributeDefinition Operation Task UpdateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateDomain /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateDomain service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateDomain service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for UpdateDomain Operation Task UpdateDomainAsync(UpdateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateProfile /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateProfile service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateProfile service method, as returned by CustomerProfiles. /// /// You do not have sufficient access to perform this action. /// /// /// The input you provided is invalid. /// /// /// An internal service error occurred. /// /// /// The requested resource does not exist, or access was denied. /// /// /// You exceeded the maximum number of requests. /// /// REST API Reference for UpdateProfile Operation Task UpdateProfileAsync(UpdateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }