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.

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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method StartOutboundVoiceContact(StartOutboundVoiceContactRequest)

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

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

If you are using an IAM account, it must have permissions 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 permissions to the connect:StopContact operation.

Public Method StopContactAsync(StopContactRequest, CancellationToken)

Initiates the asynchronous execution of the StopContact 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