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.

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.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.

There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

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
AssociateRoutingProfileQueuesResult	associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) Associates a set of queues with a routing profile.
CreateContactFlowResult	createContactFlow(CreateContactFlowRequest createContactFlowRequest) Creates a contact flow for the specified Amazon Connect instance.
CreateRoutingProfileResult	createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest) Creates a new routing profile.
CreateUserResult	createUser(CreateUserRequest createUserRequest) Creates a user account for the specified Amazon Connect instance.
DeleteUserResult	deleteUser(DeleteUserRequest deleteUserRequest) Deletes a user account from the specified Amazon Connect instance.
DescribeContactFlowResult	describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest) Describes the specified contact flow.
DescribeRoutingProfileResult	describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest) Describes the specified routing profile.
DescribeUserResult	describeUser(DescribeUserRequest describeUserRequest) Describes the specified user account.
DescribeUserHierarchyGroupResult	describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) Describes the specified hierarchy group.
DescribeUserHierarchyStructureResult	describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) Describes the hierarchy structure of the specified Amazon Connect instance.
DisassociateRoutingProfileQueuesResult	disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) Disassociates a set of queues from a routing profile.
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.
GetContactAttributesResult	getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) Retrieves the contact attributes for the specified contact.
GetCurrentMetricDataResult	getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) Gets the real-time metric data from the specified Amazon Connect instance.
GetFederationTokenResult	getFederationToken(GetFederationTokenRequest getFederationTokenRequest) Retrieves a token for federation.
GetMetricDataResult	getMetricData(GetMetricDataRequest getMetricDataRequest) Gets historical metric data from the specified Amazon Connect instance.
ListContactFlowsResult	listContactFlows(ListContactFlowsRequest listContactFlowsRequest) Provides information about the contact flows for the specified Amazon Connect instance.
ListHoursOfOperationsResult	listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest) Provides information about the hours of operation for the specified Amazon Connect instance.
ListPhoneNumbersResult	listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) Provides information about the phone numbers for the specified Amazon Connect instance.
ListPromptsResult	listPrompts(ListPromptsRequest listPromptsRequest) Provides information about the prompts for the specified Amazon Connect instance.
ListQueuesResult	listQueues(ListQueuesRequest listQueuesRequest) Provides information about the queues for the specified Amazon Connect instance.
ListRoutingProfileQueuesResult	listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) List the queues associated with a routing profile.
ListRoutingProfilesResult	listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) Provides summary information about the routing profiles for the specified Amazon Connect instance.
ListSecurityProfilesResult	listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) Provides summary information about the security profiles for the specified Amazon Connect instance.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
ListUserHierarchyGroupsResult	listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
ListUsersResult	listUsers(ListUsersRequest listUsersRequest) Provides summary information about the users for the specified Amazon Connect instance.
ResumeContactRecordingResult	resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest) When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartChatContactResult	startChatContact(StartChatContactRequest startChatContactRequest) Initiates a contact flow to start a new chat for the customer.
StartContactRecordingResult	startContactRecording(StartContactRecordingRequest startContactRecordingRequest) This API starts recording the contact when the agent joins the call.
StartOutboundVoiceContactResult	startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) This API places an outbound call to a contact, and then initiates the contact flow.
StopContactResult	stopContact(StopContactRequest stopContactRequest) Ends the specified contact.
StopContactRecordingResult	stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest) When a contact is being recorded, this API stops recording the call.
SuspendContactRecordingResult	suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) When a contact is being recorded, this API suspends recording the call.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
UpdateContactAttributesResult	updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) Creates or updates the contact attributes associated with the specified contact.
UpdateContactFlowContentResult	updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest) Updates the specified contact flow.
UpdateContactFlowNameResult	updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest) The name of the contact flow.
UpdateRoutingProfileConcurrencyResult	updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
UpdateRoutingProfileDefaultOutboundQueueResult	updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) Updates the default outbound queue of a routing profile.
UpdateRoutingProfileNameResult	updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) Updates the name and description of a routing profile.
UpdateRoutingProfileQueuesResult	updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) Updates the properties associated with a set of queues for a routing profile.
UpdateUserHierarchyResult	updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) Assigns the specified hierarchy group to the specified user.
UpdateUserIdentityInfoResult	updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) Updates the identity information for the specified user.
UpdateUserPhoneConfigResult	updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) Updates the phone configuration settings for the specified user.
UpdateUserRoutingProfileResult	updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) Assigns the specified routing profile to the specified user.
UpdateUserSecurityProfilesResult	updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) Assigns the specified security profiles to the specified user.

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

associateRoutingProfileQueues

AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)

Associates a set of queues with a routing profile.

Parameters:

associateRoutingProfileQueuesRequest -

Returns:

Result of the AssociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

createContactFlow

CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest)

Creates a contact flow for the specified Amazon Connect instance.

Parameters:

createContactFlowRequest -

Returns:

Result of the CreateContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The contact flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

createRoutingProfile

CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)

Creates a new routing profile.

Parameters:

createRoutingProfileRequest -

Returns:

Result of the CreateRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

createUser

CreateUserResult createUser(CreateUserRequest createUserRequest)

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

deleteUser

DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

describeContactFlow

DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)

Describes the specified contact flow.

Parameters:

describeContactFlowRequest -

Returns:

Result of the DescribeContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ContactFlowNotPublishedException - The contact flow has not been published.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

describeRoutingProfile

DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)

Describes the specified routing profile.

Parameters:

describeRoutingProfileRequest -

Returns:

Result of the DescribeRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

describeUser

DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

describeUserHierarchyGroup

DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)

Describes the specified hierarchy group.

Parameters:

describeUserHierarchyGroupRequest -

Returns:

Result of the DescribeUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

describeUserHierarchyStructure

DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)

Describes the hierarchy structure of the specified Amazon Connect instance.

Parameters:

describeUserHierarchyStructureRequest -

Returns:

Result of the DescribeUserHierarchyStructure operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

disassociateRoutingProfileQueues

DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)

Disassociates a set of queues from a routing profile.

Parameters:

disassociateRoutingProfileQueuesRequest -

Returns:

Result of the DisassociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

getContactAttributes

GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)

Retrieves the contact attributes for the specified contact.

Parameters:

getContactAttributesRequest -

Returns:

Result of the GetContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is 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

getCurrentMetricData

GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Parameters:

getCurrentMetricDataRequest -

Returns:

Result of the GetCurrentMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

getFederationToken

GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest)

Retrieves a token for federation.

Parameters:

getFederationTokenRequest -

Returns:

Result of the GetFederationToken operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

UserNotFoundException - No user with the specified credentials was found in the Amazon Connect instance.

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

DuplicateResourceException - A resource with the specified name already exists.

See Also:

AWS API Documentation

getMetricData

GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest)

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Parameters:

getMetricDataRequest -

Returns:

Result of the GetMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

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

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listContactFlows

ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest)

Provides information about the contact flows for the specified Amazon Connect instance.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

Parameters:

listContactFlowsRequest -

Returns:

Result of the ListContactFlows operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listHoursOfOperations

ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Parameters:

listHoursOfOperationsRequest -

Returns:

Result of the ListHoursOfOperations operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listPhoneNumbers

ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Parameters:

listPhoneNumbersRequest -

Returns:

Result of the ListPhoneNumbers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listPrompts

ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest)

Provides information about the prompts for the specified Amazon Connect instance.

Parameters:

listPromptsRequest -

Returns:

Result of the ListPrompts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listQueues

ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)

Provides information about the queues for the specified Amazon Connect instance.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

Parameters:

listQueuesRequest -

Returns:

Result of the ListQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listRoutingProfileQueues

ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)

List the queues associated with a routing profile.

Parameters:

listRoutingProfileQueuesRequest -

Returns:

Result of the ListRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listRoutingProfiles

ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Parameters:

listRoutingProfilesRequest -

Returns:

Result of the ListRoutingProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listSecurityProfiles

ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Parameters:

listSecurityProfilesRequest -

Returns:

Result of the ListSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

listUserHierarchyGroups

ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Parameters:

listUserHierarchyGroupsRequest -

Returns:

Result of the ListUserHierarchyGroups operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)

Provides summary information about the users for the specified Amazon Connect instance.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

resumeContactRecording

ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

Parameters:

resumeContactRecordingRequest -

Returns:

Result of the ResumeContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is 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

startChatContact

StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest)

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

• API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

• The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

Parameters:

startChatContactRequest -

Returns:

Result of the StartChatContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters 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 allowed limit for the resource has been exceeded.

See Also:

AWS API Documentation

startContactRecording

StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest)

This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Parameters:

startContactRecordingRequest -

Returns:

Result of the StartContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters 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

startOutboundVoiceContact

StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

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 specified parameters 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 allowed limit for the resource has been exceeded.

DestinationNotAllowedException - Outbound calls to the destination number are not allowed.

OutboundContactNotPermittedException - The contact is not permitted.

See Also:

AWS API Documentation

stopContact

StopContactResult stopContact(StopContactRequest stopContactRequest)

Ends the specified contact.

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 specified parameters 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

stopContactRecording

StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)

When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

Parameters:

stopContactRecordingRequest -

Returns:

Result of the StopContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is 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

suspendContactRecording

SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

Parameters:

suspendContactRecordingRequest -

Returns:

Result of the SuspendContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is 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

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the specified resource.

The supported resource type is users.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

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

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

See Also:

AWS API Documentation

updateContactAttributes

UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)

Creates or updates the contact attributes associated with the specified contact.

You can 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 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.

Parameters:

updateContactAttributesRequest -

Returns:

Result of the UpdateContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters 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

updateContactFlowContent

UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)

Updates the specified contact flow.

Parameters:

updateContactFlowContentRequest -

Returns:

Result of the UpdateContactFlowContent operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The contact flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateContactFlowName

UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)

The name of the contact flow.

Parameters:

updateContactFlowNameRequest -

Returns:

Result of the UpdateContactFlowName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateRoutingProfileConcurrency

UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

Parameters:

updateRoutingProfileConcurrencyRequest -

Returns:

Result of the UpdateRoutingProfileConcurrency operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateRoutingProfileDefaultOutboundQueue

UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)

Updates the default outbound queue of a routing profile.

Parameters:

updateRoutingProfileDefaultOutboundQueueRequest -

Returns:

Result of the UpdateRoutingProfileDefaultOutboundQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateRoutingProfileName

UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

Parameters:

updateRoutingProfileNameRequest -

Returns:

Result of the UpdateRoutingProfileName operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateRoutingProfileQueues

UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)

Updates the properties associated with a set of queues for a routing profile.

Parameters:

updateRoutingProfileQueuesRequest -

Returns:

Result of the UpdateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateUserHierarchy

UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)

Assigns the specified hierarchy group to the specified user.

Parameters:

updateUserHierarchyRequest -

Returns:

Result of the UpdateUserHierarchy operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateUserIdentityInfo

UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)

Updates the identity information for the specified user.

Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

Parameters:

updateUserIdentityInfoRequest -

Returns:

Result of the UpdateUserIdentityInfo operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateUserPhoneConfig

UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)

Updates the phone configuration settings for the specified user.

Parameters:

updateUserPhoneConfigRequest -

Returns:

Result of the UpdateUserPhoneConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateUserRoutingProfile

UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)

Assigns the specified routing profile to the specified user.

Parameters:

updateUserRoutingProfileRequest -

Returns:

Result of the UpdateUserRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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

See Also:

AWS API Documentation

updateUserSecurityProfiles

UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)

Assigns the specified security profiles to the specified user.

Parameters:

updateUserSecurityProfilesRequest -

Returns:

Result of the UpdateUserSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

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.