/*
* 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.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.CustomerProfiles.Model;
using Amazon.CustomerProfiles.Model.Internal.MarshallTransformations;
using Amazon.CustomerProfiles.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.CustomerProfiles
{
///
/// Implementation 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 class AmazonCustomerProfilesClient : AmazonServiceClient, IAmazonCustomerProfiles
{
private static IServiceMetadata serviceMetadata = new AmazonCustomerProfilesMetadata();
private ICustomerProfilesPaginatorFactory _paginators;
///
/// Paginators for the service
///
public ICustomerProfilesPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new CustomerProfilesPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonCustomerProfilesClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonCustomerProfilesClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCustomerProfilesConfig()) { }
///
/// Constructs AmazonCustomerProfilesClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonCustomerProfilesClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCustomerProfilesConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonCustomerProfilesClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonCustomerProfilesClient Configuration Object
public AmazonCustomerProfilesClient(AmazonCustomerProfilesConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonCustomerProfilesClient with AWS Credentials
///
/// AWS Credentials
public AmazonCustomerProfilesClient(AWSCredentials credentials)
: this(credentials, new AmazonCustomerProfilesConfig())
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonCustomerProfilesClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonCustomerProfilesConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Credentials and an
/// AmazonCustomerProfilesClient Configuration object.
///
/// AWS Credentials
/// The AmazonCustomerProfilesClient Configuration Object
public AmazonCustomerProfilesClient(AWSCredentials credentials, AmazonCustomerProfilesConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCustomerProfilesConfig())
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCustomerProfilesConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCustomerProfilesClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonCustomerProfilesClient Configuration Object
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonCustomerProfilesConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCustomerProfilesConfig())
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCustomerProfilesConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCustomerProfilesClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCustomerProfilesClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonCustomerProfilesClient Configuration Object
public AmazonCustomerProfilesClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCustomerProfilesConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonCustomerProfilesEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#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.
///
/// 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
public virtual AddProfileKeyResponse AddProfileKey(AddProfileKeyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = AddProfileKeyRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddProfileKeyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task AddProfileKeyAsync(AddProfileKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = AddProfileKeyRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddProfileKeyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual CreateCalculatedAttributeDefinitionResponse CreateCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task CreateCalculatedAttributeDefinitionAsync(CreateCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual CreateDomainResponse CreateDomain(CreateDomainRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDomainResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task CreateDomainAsync(CreateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDomainResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual CreateEventStreamResponse CreateEventStream(CreateEventStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateEventStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task CreateEventStreamAsync(CreateEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateEventStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual CreateIntegrationWorkflowResponse CreateIntegrationWorkflow(CreateIntegrationWorkflowRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateIntegrationWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateIntegrationWorkflowResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task CreateIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateIntegrationWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateIntegrationWorkflowResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual CreateProfileResponse CreateProfile(CreateProfileRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateProfileResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task CreateProfileAsync(CreateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateProfileResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteCalculatedAttributeDefinitionResponse DeleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteDomainResponse DeleteDomain(DeleteDomainRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDomainResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteDomainAsync(DeleteDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDomainResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteEventStream
///
/// Disables and deletes the specified event stream.
///
/// Container for the necessary parameters to execute the DeleteEventStream service method.
///
/// 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
public virtual DeleteEventStreamResponse DeleteEventStream(DeleteEventStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteEventStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteEventStreamAsync(DeleteEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteEventStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteIntegration
///
/// Removes an integration from a specific domain.
///
/// Container for the necessary parameters to execute the DeleteIntegration service method.
///
/// 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
public virtual DeleteIntegrationResponse DeleteIntegration(DeleteIntegrationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIntegrationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteIntegrationAsync(DeleteIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIntegrationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteProfileResponse DeleteProfile(DeleteProfileRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteProfileAsync(DeleteProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteProfileKey
///
/// Removes a searchable key from a customer profile.
///
/// Container for the necessary parameters to execute the DeleteProfileKey service method.
///
/// 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
public virtual DeleteProfileKeyResponse DeleteProfileKey(DeleteProfileKeyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileKeyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileKeyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteProfileKeyAsync(DeleteProfileKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileKeyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileKeyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteProfileObjectResponse DeleteProfileObject(DeleteProfileObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteProfileObjectAsync(DeleteProfileObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileObjectResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteProfileObjectTypeResponse DeleteProfileObjectType(DeleteProfileObjectTypeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileObjectTypeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteProfileObjectTypeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual DeleteWorkflowResponse DeleteWorkflow(DeleteWorkflowRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteWorkflowResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task DeleteWorkflowAsync(DeleteWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteWorkflowResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetAutoMergingPreviewResponse GetAutoMergingPreview(GetAutoMergingPreviewRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetAutoMergingPreviewRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetAutoMergingPreviewResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetAutoMergingPreviewRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetAutoMergingPreviewResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetCalculatedAttributeDefinitionResponse GetCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetCalculatedAttributeForProfile
///
/// Retrieve a calculated attribute for a customer profile.
///
/// Container for the necessary parameters to execute the GetCalculatedAttributeForProfile service method.
///
/// 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
public virtual GetCalculatedAttributeForProfileResponse GetCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCalculatedAttributeForProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCalculatedAttributeForProfileResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCalculatedAttributeForProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCalculatedAttributeForProfileResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetDomain
///
/// Returns information about a specific domain.
///
/// Container for the necessary parameters to execute the GetDomain service method.
///
/// 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
public virtual GetDomainResponse GetDomain(GetDomainRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDomainResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetDomainAsync(GetDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDomainResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetEventStreamResponse GetEventStream(GetEventStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetEventStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetEventStreamAsync(GetEventStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetEventStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetEventStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetIdentityResolutionJobResponse GetIdentityResolutionJob(GetIdentityResolutionJobRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdentityResolutionJobRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdentityResolutionJobResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdentityResolutionJobRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdentityResolutionJobResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetIntegration
///
/// Returns an integration for a domain.
///
/// Container for the necessary parameters to execute the GetIntegration service method.
///
/// 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
public virtual GetIntegrationResponse GetIntegration(GetIntegrationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIntegrationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetIntegrationAsync(GetIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIntegrationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetMatchesResponse GetMatches(GetMatchesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMatchesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMatchesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetMatchesAsync(GetMatchesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMatchesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMatchesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetProfileObjectType
///
/// Returns the object types for a specific domain.
///
/// Container for the necessary parameters to execute the GetProfileObjectType service method.
///
/// 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
public virtual GetProfileObjectTypeResponse GetProfileObjectType(GetProfileObjectTypeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetProfileObjectTypeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetProfileObjectTypeAsync(GetProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetProfileObjectTypeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetProfileObjectTypeTemplateResponse GetProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetProfileObjectTypeTemplateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetProfileObjectTypeTemplateResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetProfileObjectTypeTemplateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetProfileObjectTypeTemplateResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual GetSimilarProfilesResponse GetSimilarProfiles(GetSimilarProfilesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetSimilarProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetSimilarProfilesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetSimilarProfilesAsync(GetSimilarProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetSimilarProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetSimilarProfilesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetWorkflow
///
/// Get details of specified workflow.
///
/// Container for the necessary parameters to execute the GetWorkflow service method.
///
/// 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
public virtual GetWorkflowResponse GetWorkflow(GetWorkflowRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetWorkflowResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetWorkflowAsync(GetWorkflowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetWorkflowRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetWorkflowResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetWorkflowSteps
///
/// Get granular list of steps in workflow.
///
/// Container for the necessary parameters to execute the GetWorkflowSteps service method.
///
/// 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
public virtual GetWorkflowStepsResponse GetWorkflowSteps(GetWorkflowStepsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetWorkflowStepsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetWorkflowStepsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task GetWorkflowStepsAsync(GetWorkflowStepsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetWorkflowStepsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetWorkflowStepsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListAccountIntegrationsResponse ListAccountIntegrations(ListAccountIntegrationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListAccountIntegrationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListAccountIntegrationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListAccountIntegrationsAsync(ListAccountIntegrationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListAccountIntegrationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListAccountIntegrationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListCalculatedAttributeDefinitions
///
/// Lists calculated attribute definitions for Customer Profiles
///
/// Container for the necessary parameters to execute the ListCalculatedAttributeDefinitions service method.
///
/// 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
public virtual ListCalculatedAttributeDefinitionsResponse ListCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCalculatedAttributeDefinitionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCalculatedAttributeDefinitionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCalculatedAttributeDefinitionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCalculatedAttributeDefinitionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListCalculatedAttributesForProfileResponse ListCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCalculatedAttributesForProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCalculatedAttributesForProfileResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCalculatedAttributesForProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCalculatedAttributesForProfileResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListDomainsResponse ListDomains(ListDomainsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListDomainsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListDomainsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListDomainsAsync(ListDomainsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListDomainsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListDomainsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListEventStreamsResponse ListEventStreams(ListEventStreamsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListEventStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListEventStreamsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListEventStreamsAsync(ListEventStreamsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListEventStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListEventStreamsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListIdentityResolutionJobsResponse ListIdentityResolutionJobs(ListIdentityResolutionJobsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentityResolutionJobsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentityResolutionJobsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListIdentityResolutionJobsAsync(ListIdentityResolutionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentityResolutionJobsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentityResolutionJobsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListIntegrations
///
/// Lists all of the integrations in your domain.
///
/// Container for the necessary parameters to execute the ListIntegrations service method.
///
/// 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
public virtual ListIntegrationsResponse ListIntegrations(ListIntegrationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIntegrationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIntegrationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListIntegrationsAsync(ListIntegrationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIntegrationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIntegrationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListProfileObjectsResponse ListProfileObjects(ListProfileObjectsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListProfileObjectsAsync(ListProfileObjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListProfileObjectTypes
///
/// Lists all of the templates available within the service.
///
/// Container for the necessary parameters to execute the ListProfileObjectTypes service method.
///
/// 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
public virtual ListProfileObjectTypesResponse ListProfileObjectTypes(ListProfileObjectTypesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectTypesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectTypesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListProfileObjectTypesAsync(ListProfileObjectTypesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectTypesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectTypesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListProfileObjectTypeTemplates
///
/// Lists all of the template information for object types.
///
/// Container for the necessary parameters to execute the ListProfileObjectTypeTemplates service method.
///
/// 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
public virtual ListProfileObjectTypeTemplatesResponse ListProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectTypeTemplatesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectTypeTemplatesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListProfileObjectTypeTemplatesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListProfileObjectTypeTemplatesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListRuleBasedMatchesResponse ListRuleBasedMatches(ListRuleBasedMatchesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListRuleBasedMatchesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListRuleBasedMatchesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListRuleBasedMatchesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListRuleBasedMatchesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListWorkflows
///
/// Query to list all workflows.
///
/// Container for the necessary parameters to execute the ListWorkflows service method.
///
/// 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
public virtual ListWorkflowsResponse ListWorkflows(ListWorkflowsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListWorkflowsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListWorkflowsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task ListWorkflowsAsync(ListWorkflowsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListWorkflowsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListWorkflowsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region MergeProfiles
///
/// 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).
///
///
/// Container for the necessary parameters to execute the MergeProfiles service method.
///
/// 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
public virtual MergeProfilesResponse MergeProfiles(MergeProfilesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = MergeProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = MergeProfilesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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).
///
///
/// 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
public virtual Task MergeProfilesAsync(MergeProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = MergeProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = MergeProfilesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual PutIntegrationResponse PutIntegration(PutIntegrationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutIntegrationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task PutIntegrationAsync(PutIntegrationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutIntegrationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutIntegrationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual PutProfileObjectResponse PutProfileObject(PutProfileObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutProfileObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutProfileObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task PutProfileObjectAsync(PutProfileObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutProfileObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutProfileObjectResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual PutProfileObjectTypeResponse PutProfileObjectType(PutProfileObjectTypeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutProfileObjectTypeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task PutProfileObjectTypeAsync(PutProfileObjectTypeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutProfileObjectTypeRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutProfileObjectTypeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual SearchProfilesResponse SearchProfiles(SearchProfilesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SearchProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = SearchProfilesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task SearchProfilesAsync(SearchProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = SearchProfilesRequestMarshaller.Instance;
options.ResponseUnmarshaller = SearchProfilesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual UpdateCalculatedAttributeDefinitionResponse UpdateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task UpdateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCalculatedAttributeDefinitionRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCalculatedAttributeDefinitionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual UpdateDomainResponse UpdateDomain(UpdateDomainRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateDomainResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task UpdateDomainAsync(UpdateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateDomainRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateDomainResponseUnmarshaller.Instance;
return InvokeAsync(request, options, 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.
///
/// 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
public virtual UpdateProfileResponse UpdateProfile(UpdateProfileRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateProfileResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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
public virtual Task UpdateProfileAsync(UpdateProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateProfileRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateProfileResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}