@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnect extends Object implements AmazonConnect
AmazonConnect. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
|
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.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified contact flow.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
|
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.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
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 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.
|
ListPromptsResult |
listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
List the queues associated with a routing profile.
|
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.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
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 request)
Initiates a contact flow to start a new chat for the customer.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest request)
This API starts recording the contact when the agent joins the call.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
This API places an outbound call to a contact, and then initiates the contact flow.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest request)
When a contact is being recorded, this API stops recording the call.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call.
|
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.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified contact flow.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the contact flow.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
|
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.
|
public AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
AmazonConnectAssociates a set of queues with a routing profile.
associateRoutingProfileQueues in interface AmazonConnectpublic CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
AmazonConnectCreates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlow in interface AmazonConnectpublic CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
AmazonConnectCreates a new routing profile.
createRoutingProfile in interface AmazonConnectpublic CreateUserResult createUser(CreateUserRequest request)
AmazonConnectCreates 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.
createUser in interface AmazonConnectpublic DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonConnectDeletes 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.
deleteUser in interface AmazonConnectpublic DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
AmazonConnectDescribes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
describeContactFlow in interface AmazonConnectpublic DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
AmazonConnectDescribes the specified routing profile.
describeRoutingProfile in interface AmazonConnectpublic DescribeUserResult describeUser(DescribeUserRequest request)
AmazonConnectDescribes 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 AmazonConnectpublic DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
AmazonConnectDescribes the specified hierarchy group.
describeUserHierarchyGroup in interface AmazonConnectpublic DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
AmazonConnectDescribes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure in interface AmazonConnectpublic DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
AmazonConnectDisassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues in interface AmazonConnectpublic GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
AmazonConnectRetrieves the contact attributes for the specified contact.
getContactAttributes in interface AmazonConnectpublic GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
AmazonConnectGets 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.
getCurrentMetricData in interface AmazonConnectpublic GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
AmazonConnectRetrieves a token for federation.
getFederationToken in interface AmazonConnectpublic GetMetricDataResult getMetricData(GetMetricDataRequest request)
AmazonConnectGets 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.
getMetricData in interface AmazonConnectpublic ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
AmazonConnectProvides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
listContactFlows in interface AmazonConnectpublic ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
AmazonConnectProvides 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.
listHoursOfOperations in interface AmazonConnectpublic ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonConnectProvides 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.
listPhoneNumbers in interface AmazonConnectpublic ListPromptsResult listPrompts(ListPromptsRequest request)
AmazonConnectProvides information about the prompts for the specified Amazon Connect instance.
listPrompts in interface AmazonConnectpublic ListQueuesResult listQueues(ListQueuesRequest request)
AmazonConnectProvides 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.
listQueues in interface AmazonConnectpublic ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
AmazonConnectList the queues associated with a routing profile.
listRoutingProfileQueues in interface AmazonConnectpublic ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
AmazonConnectProvides 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.
listRoutingProfiles in interface AmazonConnectpublic ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AmazonConnectProvides 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.
listSecurityProfiles in interface AmazonConnectpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonConnectLists 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.
listTagsForResource in interface AmazonConnectpublic ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
AmazonConnectProvides 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.
listUserHierarchyGroups in interface AmazonConnectpublic ListUsersResult listUsers(ListUsersRequest request)
AmazonConnectProvides summary information about the users for the specified Amazon Connect instance.
listUsers in interface AmazonConnectpublic ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
AmazonConnectWhen 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.
resumeContactRecording in interface AmazonConnectpublic StartChatContactResult startChatContact(StartChatContactRequest request)
AmazonConnectInitiates 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.
startChatContact in interface AmazonConnectpublic StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
AmazonConnectThis 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.
startContactRecording in interface AmazonConnectpublic StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
AmazonConnect
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.
startOutboundVoiceContact in interface AmazonConnectpublic StopContactResult stopContact(StopContactRequest request)
AmazonConnectEnds the specified contact.
stopContact in interface AmazonConnectpublic StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
AmazonConnectWhen 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.
stopContactRecording in interface AmazonConnectpublic SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
AmazonConnectWhen 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.
suspendContactRecording in interface AmazonConnectpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonConnectAdds the specified tags to the specified resource.
The supported resource types are users, routing profiles, and contact flows.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResource in interface AmazonConnectpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonConnectRemoves the specified tags from the specified resource.
untagResource in interface AmazonConnectpublic UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
AmazonConnectCreates 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.
This operation is also available in the Amazon Connect Flow language. See UpdateContactAttributes.
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 AmazonConnectpublic UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
AmazonConnectUpdates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContent in interface AmazonConnectpublic UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
AmazonConnectThe name of the contact flow.
updateContactFlowName in interface AmazonConnectpublic UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
AmazonConnectUpdates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency in interface AmazonConnectpublic UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
AmazonConnectUpdates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue in interface AmazonConnectpublic UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
AmazonConnect
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.
updateRoutingProfileName in interface AmazonConnectpublic UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
AmazonConnectUpdates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues in interface AmazonConnectpublic UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
AmazonConnectAssigns the specified hierarchy group to the specified user.
updateUserHierarchy in interface AmazonConnectpublic UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
AmazonConnectUpdates 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.
updateUserIdentityInfo in interface AmazonConnectpublic UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
AmazonConnectUpdates the phone configuration settings for the specified user.
updateUserPhoneConfig in interface AmazonConnectpublic UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
AmazonConnectAssigns the specified routing profile to the specified user.
updateUserRoutingProfile in interface AmazonConnectpublic UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
AmazonConnectAssigns the specified security profiles to the specified user.
updateUserSecurityProfiles in interface AmazonConnectpublic void shutdown()
AmazonConnectshutdown in interface AmazonConnectpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnectResponse 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.
getCachedResponseMetadata in interface AmazonConnectrequest - The originally executed request.