com.amazonaws.services.connect

Interface AmazonConnect

All Known Subinterfaces:

AmazonConnectAsync

All Known Implementing Classes:

AbstractAmazonConnect, AbstractAmazonConnectAsync, AmazonConnectAsyncClient, AmazonConnectClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnect

Interface for accessing Amazon Connect.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonConnect instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartOutboundVoiceContactResult	startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
StopContactResult	stopContact(StopContactRequest stopContactRequest) Ends the contact initiated by the StartOutboundVoiceContact operation.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

startOutboundVoiceContact

StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest 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.

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

StopContactResult stopContact(StopContactRequest 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.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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