AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Connect The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

There is a throttling limit placed on usage of the Amazon Connect operations that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Connect.AmazonConnectClient

Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonConnectClient : AmazonServiceClient
         IAmazonConnect, IAmazonService, IDisposable

The AmazonConnectClient type exposes the following members

Constructors

NameDescription
Public Method AmazonConnectClient()

Constructs AmazonConnectClient 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.



    
        
    

             

Public Method AmazonConnectClient(RegionEndpoint)

Constructs AmazonConnectClient 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.



    
        
    

             

Public Method AmazonConnectClient(AmazonConnectConfig)

Constructs AmazonConnectClient 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.



    
        
    

             

Public Method AmazonConnectClient(AWSCredentials)

Constructs AmazonConnectClient with AWS Credentials

Public Method AmazonConnectClient(AWSCredentials, RegionEndpoint)

Constructs AmazonConnectClient with AWS Credentials

Public Method AmazonConnectClient(AWSCredentials, AmazonConnectConfig)

Constructs AmazonConnectClient with AWS Credentials and an AmazonConnectClient Configuration object.

Public Method AmazonConnectClient(string, string)

Constructs AmazonConnectClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectClient(string, string, RegionEndpoint)

Constructs AmazonConnectClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectClient(string, string, AmazonConnectConfig)

Constructs AmazonConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectClient Configuration object.

Public Method AmazonConnectClient(string, string, string)

Constructs AmazonConnectClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectClient(string, string, string, RegionEndpoint)

Constructs AmazonConnectClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectClient(string, string, string, AmazonConnectConfig)

Constructs AmazonConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateUser(CreateUserRequest)

Creates a new user account in your Amazon Connect instance.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes a user account from Amazon Connect.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DescribeUser(DescribeUserRequest)

Returns a User object that contains information about the user account specified by the UserId.

Public Method DescribeUserAsync(DescribeUserRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUser operation.

Public Method DescribeUserHierarchyGroup(DescribeUserHierarchyGroupRequest)

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

Public Method DescribeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserHierarchyGroup operation.

Public Method DescribeUserHierarchyStructure(DescribeUserHierarchyStructureRequest)

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

Public Method DescribeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserHierarchyStructure operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetCurrentMetricData(GetCurrentMetricDataRequest)

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

Public Method GetCurrentMetricDataAsync(GetCurrentMetricDataRequest, CancellationToken)

Initiates the asynchronous execution of the GetCurrentMetricData operation.

Public Method GetFederationToken(GetFederationTokenRequest)

Retrieves a token for federation.

Public Method GetFederationTokenAsync(GetFederationTokenRequest, CancellationToken)

Initiates the asynchronous execution of the GetFederationToken operation.

Public Method GetMetricData(GetMetricDataRequest)

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

Public Method GetMetricDataAsync(GetMetricDataRequest, CancellationToken)

Initiates the asynchronous execution of the GetMetricData operation.

Public Method ListRoutingProfiles(ListRoutingProfilesRequest)

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

Public Method ListRoutingProfilesAsync(ListRoutingProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRoutingProfiles operation.

Public Method ListSecurityProfiles(ListSecurityProfilesRequest)

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

Public Method ListSecurityProfilesAsync(ListSecurityProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListSecurityProfiles operation.

Public Method ListUserHierarchyGroups(ListUserHierarchyGroupsRequest)

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

Public Method ListUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserHierarchyGroups operation.

Public Method ListUsers(ListUsersRequest)

Returns a UserSummaryList, which is an array of UserSummary objects.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsers operation.

Public Method StartOutboundVoiceContact(StartOutboundVoiceContactRequest)

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

Public Method StartOutboundVoiceContactAsync(StartOutboundVoiceContactRequest, CancellationToken)

Initiates the asynchronous execution of the StartOutboundVoiceContact operation.

Public Method StopContact(StopContactRequest)

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

Public Method StopContactAsync(StopContactRequest, CancellationToken)

Initiates the asynchronous execution of the StopContact operation.

Public Method UpdateContactAttributes(UpdateContactAttributesRequest)

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important:

You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Public Method UpdateContactAttributesAsync(UpdateContactAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateContactAttributes operation.

Public Method UpdateUserHierarchy(UpdateUserHierarchyRequest)

Assigns the specified hierarchy group to the user.

Public Method UpdateUserHierarchyAsync(UpdateUserHierarchyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserHierarchy operation.

Public Method UpdateUserIdentityInfo(UpdateUserIdentityInfoRequest)

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

Public Method UpdateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserIdentityInfo operation.

Public Method UpdateUserPhoneConfig(UpdateUserPhoneConfigRequest)

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

Public Method UpdateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserPhoneConfig operation.

Public Method UpdateUserRoutingProfile(UpdateUserRoutingProfileRequest)

Assigns the specified routing profile to a user.

Public Method UpdateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserRoutingProfile operation.

Public Method UpdateUserSecurityProfiles(UpdateUserSecurityProfilesRequest)

Updates the security profiles assigned to the user.

Public Method UpdateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserSecurityProfiles operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms