@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectClient extends AmazonWebServiceClient implements AmazonConnect
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 Limits in the Amazon Connect Administrator Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AmazonConnectClientBuilder |
builder() |
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
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 request)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the contact flows for the specified Amazon Connect instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
StartChatContactResult |
startChatContact(StartChatContactRequest request)
Initiates a contact flow to start a new chat for the customer.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
Initiates a contact flow to place an outbound call to a customer.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest request)
Creates or updates the contact attributes associated with the specified contact.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonConnectClientBuilder builder()
public CreateUserResult createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
createUser
in interface AmazonConnect
createUserRequest
- 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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
deleteUser
in interface AmazonConnect
deleteUserRequest
- 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.public DescribeUserResult describeUser(DescribeUserRequest request)
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.
describeUser
in interface AmazonConnect
describeUserRequest
- 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.public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
describeUserHierarchyGroupRequest
- 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.public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
describeUserHierarchyStructureRequest
- 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.public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
getContactAttributesRequest
- 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.public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.
getCurrentMetricData
in interface AmazonConnect
getCurrentMetricDataRequest
- 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.public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
getFederationToken
in interface AmazonConnect
getFederationTokenRequest
- 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.public GetMetricDataResult getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.
getMetricData
in interface AmazonConnect
getMetricDataRequest
- 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.public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
Provides information about the contact flows for the specified Amazon Connect instance.
listContactFlows
in interface AmazonConnect
listContactFlowsRequest
- 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.public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
listHoursOfOperations
in interface AmazonConnect
listHoursOfOperationsRequest
- 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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
listPhoneNumbers
in interface AmazonConnect
listPhoneNumbersRequest
- 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.public ListQueuesResult listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
listQueues
in interface AmazonConnect
listQueuesRequest
- 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.public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
listRoutingProfiles
in interface AmazonConnect
listRoutingProfilesRequest
- 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.public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
listSecurityProfiles
in interface AmazonConnect
listSecurityProfilesRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
listTagsForResource
in interface AmazonConnect
listTagsForResourceRequest
- 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.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
listUserHierarchyGroups
in interface AmazonConnect
listUserHierarchyGroupsRequest
- 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.public ListUsersResult listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
listUsersRequest
- 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.public StartChatContactResult startChatContact(StartChatContactRequest request)
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.
startChatContact
in interface AmazonConnect
startChatContactRequest
- 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.public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
Initiates a contact flow to place an outbound call to a customer.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
startOutboundVoiceContact
in interface AmazonConnect
startOutboundVoiceContactRequest
- 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.public StopContactResult stopContact(StopContactRequest request)
Ends the specified contact.
stopContact
in interface AmazonConnect
stopContactRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
The supported resource type is users.
tagResource
in interface AmazonConnect
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
untagResourceRequest
- 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.public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
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.
updateContactAttributes
in interface AmazonConnect
updateContactAttributesRequest
- 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.public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
updateUserHierarchyRequest
- 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.public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
updateUserIdentityInfo
in interface AmazonConnect
updateUserIdentityInfoRequest
- 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.public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
updateUserPhoneConfigRequest
- 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.public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
updateUserRoutingProfileRequest
- 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.public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
updateUserSecurityProfilesRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonConnect
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.