com.amazonaws.services.connect

Class AmazonConnectClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.connect.AmazonConnectClient

All Implemented Interfaces:

AmazonConnect

Direct Known Subclasses:

AmazonConnectAsyncClient

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

Client for accessing Amazon Connect. All service calls made using this client are blocking, and will not return until the service call 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 AmazonConnectClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
StartOutboundVoiceContactResult	startOutboundVoiceContact(StartOutboundVoiceContactRequest request) The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
StopContactResult	stopContact(StopContactRequest request) Ends the contact initiated by the StartOutboundVoiceContact operation.

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, shutdown, 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

shutdown

Method Detail

builder

public static AmazonConnectClientBuilder builder()

startOutboundVoiceContact

public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)

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:

startOutboundVoiceContact in interface AmazonConnect

Parameters:

startOutboundVoiceContactRequest -

Returns:

Result of the StartOutboundVoiceContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed due to an error or failure with the service.

LimitExceededException - The limit exceeded the maximum allowed active calls in a queue.

DestinationNotAllowedException - Outbound calls to the destination number are not allowed for your instance. You can request that the country be included in the allowed countries for your instance by submitting a Service Limit Increase.

OutboundContactNotPermittedException - The contact is not permitted because outbound calling is not enabled for the instance.

See Also:

AWS API Documentation

stopContact

public StopContactResult stopContact(StopContactRequest request)

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:

stopContact in interface AmazonConnect

Parameters:

stopContactRequest -

Returns:

Result of the StopContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ContactNotFoundException - The contact with the specified ID is not active or does not exist.

InvalidParameterException - One or more of the parameters provided to the operation are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed due to an error or failure with the service.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonConnect

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.