com.amazonaws.services.connect

Class AmazonConnectAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.connect.AmazonConnectClient

com.amazonaws.services.connect.AmazonConnectAsyncClient

All Implemented Interfaces:

AmazonConnect, AmazonConnectAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonConnectAsyncClient
extends AmazonConnectClient
implements AmazonConnectAsync

Client for accessing Amazon Connect asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.connect.AmazonConnect

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonConnectAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<StartOutboundVoiceContactResult>	startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request) The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
Future<StartOutboundVoiceContactResult>	startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request, AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler) The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
Future<StopContactResult>	stopContactAsync(StopContactRequest request) Ends the contact initiated by the StartOutboundVoiceContact operation.
Future<StopContactResult>	stopContactAsync(StopContactRequest request, AsyncHandler<StopContactRequest,StopContactResult> asyncHandler) Ends the contact initiated by the StartOutboundVoiceContact operation.

Methods inherited from class com.amazonaws.services.connect.AmazonConnectClient

builder, getCachedResponseMetadata, startOutboundVoiceContact, stopContact

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.connect.AmazonConnect

getCachedResponseMetadata, startOutboundVoiceContact, stopContact

Method Detail

asyncBuilder

public static AmazonConnectAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

startOutboundVoiceContactAsync

public Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request)

Description copied from interface: AmazonConnectAsync

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.

Specified by:

startOutboundVoiceContactAsync in interface AmazonConnectAsync

Returns:

A Java Future containing the result of the StartOutboundVoiceContact operation returned by the service.

See Also:

AWS API Documentation

startOutboundVoiceContactAsync

public Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request,
                                                                              AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler)

Description copied from interface: AmazonConnectAsync

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.

Specified by:

startOutboundVoiceContactAsync in interface AmazonConnectAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartOutboundVoiceContact operation returned by the service.

See Also:

AWS API Documentation

stopContactAsync

public Future<StopContactResult> stopContactAsync(StopContactRequest request)

Description copied from interface: AmazonConnectAsync

Ends the contact initiated by the StartOutboundVoiceContact operation.

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

Specified by:

stopContactAsync in interface AmazonConnectAsync

Returns:

A Java Future containing the result of the StopContact operation returned by the service.

See Also:

AWS API Documentation

stopContactAsync

public Future<StopContactResult> stopContactAsync(StopContactRequest request,
                                                  AsyncHandler<StopContactRequest,StopContactResult> asyncHandler)

Description copied from interface: AmazonConnectAsync

Ends the contact initiated by the StartOutboundVoiceContact operation.

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

Specified by:

stopContactAsync in interface AmazonConnectAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopContact operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonConnect

Overrides:

shutdown in class AmazonWebServiceClient