public interface AmazonConnect
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also 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.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
| Modifier and Type | Method and Description |
|---|---|
ActivateEvaluationFormResult |
activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest)
Activates an evaluation form in the specified Amazon Connect instance.
|
void |
associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateBot(AssociateBotRequest associateBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
AssociateDefaultVocabularyResult |
associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)
Associates an existing vocabulary as the default.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateLexBot(AssociateLexBotRequest associateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)
Associates a flow with a phone number claimed to your Amazon Connect
instance.
|
void |
associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
AssociateTrafficDistributionGroupUserResult |
associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)
Associates an agent with a traffic distribution group.
|
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest)
Claims an available phone number to your Amazon Connect instance or
traffic distribution group.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest createContactFlowRequest)
Creates a flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)
Creates a flow module for the specified Amazon Connect instance.
|
CreateEvaluationFormResult |
createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest)
Creates an evaluation form in the specified Amazon Connect instance.
|
CreateHoursOfOperationResult |
createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest createInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
Creates an Amazon Web Services resource association with an Amazon
Connect instance.
|
CreateParticipantResult |
createParticipant(CreateParticipantRequest createParticipantRequest)
Adds a new participant into an on-going chat contact.
|
CreatePromptResult |
createPrompt(CreatePromptRequest createPromptRequest)
Creates a prompt.
|
CreateQueueResult |
createQueue(CreateQueueRequest createQueueRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)
Creates a quick connect for the specified Amazon Connect instance.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)
Creates a new routing profile.
|
CreateRuleResult |
createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified Amazon Connect instance.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateTaskTemplateResult |
createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest)
Creates a new task template in the specified Amazon Connect instance.
|
CreateTrafficDistributionGroupResult |
createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)
Creates a traffic distribution group given an Amazon Connect instance
that has been replicated.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest createUseCaseRequest)
Creates a use case for an integration association.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
Creates a new user hierarchy group.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest createVocabularyRequest)
Creates a custom vocabulary associated with your Amazon Connect instance.
|
DeactivateEvaluationFormResult |
deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)
Deactivates an evaluation form in the specified Amazon Connect instance.
|
void |
deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest)
Deletes a contact evaluation in the specified Amazon Connect instance.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
Deletes the specified flow module.
|
void |
deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest)
Deletes an evaluation form in the specified Amazon Connect instance.
|
void |
deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
Deletes an Amazon Web Services resource association from an Amazon
Connect instance.
|
void |
deletePrompt(DeletePromptRequest deletePromptRequest)
Deletes a prompt.
|
void |
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes a queue.
|
void |
deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes a quick connect.
|
void |
deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest)
Deletes a routing profile.
|
void |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes a rule for the specified Amazon Connect instance.
|
void |
deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DeleteTaskTemplateResult |
deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest)
Deletes the task template.
|
DeleteTrafficDistributionGroupResult |
deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)
Deletes a traffic distribution group.
|
void |
deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)
Deletes a use case from an integration association.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from the specified Amazon Connect instance.
|
void |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
Deletes an existing user hierarchy group.
|
DeleteVocabularyResult |
deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
Deletes the vocabulary that has the given identifier.
|
DescribeAgentStatusResult |
describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeContactResult |
describeContact(DescribeContactRequest describeContactRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeContactEvaluationResult |
describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest)
Describes a contact evaluation in the specified Amazon Connect instance.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
Describes the specified flow module.
|
DescribeEvaluationFormResult |
describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest)
Describes an evaluation form in the specified Amazon Connect instance.
|
DescribeHoursOfOperationResult |
describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest describeInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribePhoneNumberResult |
describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest)
Gets details and status of a phone number that’s claimed to your Amazon
Connect instance or traffic distribution group.
|
DescribePromptResult |
describePrompt(DescribePromptRequest describePromptRequest)
Describes the prompt.
|
DescribeQueueResult |
describeQueue(DescribeQueueRequest describeQueueRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)
Describes the quick connect.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)
Describes the specified routing profile.
|
DescribeRuleResult |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes a rule for the specified Amazon Connect instance.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeTrafficDistributionGroupResult |
describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)
Gets details and status of a traffic distribution group.
|
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.
|
DescribeVocabularyResult |
describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest)
Describes the specified vocabulary.
|
void |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateBot(DisassociateBotRequest disassociateBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)
Removes the flow association from a phone number claimed to your Amazon
Connect instance.
|
void |
disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
Disassociates a set of queues from a routing profile.
|
void |
disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DisassociateTrafficDistributionGroupUserResult |
disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)
Disassociates an agent from a traffic distribution group.
|
DismissUserContactResult |
dismissUserContact(DismissUserContactRequest dismissUserContactRequest)
Dismisses contacts from an agent’s CCP and returns the agent to an
available state, which allows the agent to receive a new routed contact.
|
com.amazonaws.ResponseMetadata |
getCachedResponseMetadata(com.amazonaws.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.
|
GetCurrentUserDataResult |
getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest)
Gets the real-time active user 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.
|
GetMetricDataV2Result |
getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request)
Gets metric data from the specified Amazon Connect instance.
|
GetPromptFileResult |
getPromptFile(GetPromptFileRequest getPromptFileRequest)
Gets the prompt file.
|
GetTaskTemplateResult |
getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest)
Gets details about a specific task template in the specified Amazon
Connect instance.
|
GetTrafficDistributionResult |
getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest)
Retrieves the current traffic distribution for a given traffic
distribution group.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListContactEvaluationsResult |
listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest)
Lists contact evaluations in the specified Amazon Connect instance.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the flow modules for the specified Amazon
Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the flows for the specified Amazon Connect
instance.
|
ListContactReferencesResult |
listContactReferences(ListContactReferencesRequest listContactReferencesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListDefaultVocabulariesResult |
listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
Lists the default vocabularies for the specified Amazon Connect instance.
|
ListEvaluationFormsResult |
listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest)
Lists evaluation forms in the specified Amazon Connect instance.
|
ListEvaluationFormVersionsResult |
listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
Lists versions of an evaluation form in the specified Amazon Connect
instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
Provides information about the hours of operation for the specified
Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListInstancesResult |
listInstances(ListInstancesRequest listInstancesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
Provides summary information about the Amazon Web Services resource
associations for the specified Amazon Connect instance.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest listLexBotsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Provides information about the phone numbers for the specified Amazon
Connect instance.
|
ListPhoneNumbersV2Result |
listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
Lists phone numbers claimed to your Amazon Connect instance or traffic
distribution group.
|
ListPromptsResult |
listPrompts(ListPromptsRequest listPromptsRequest)
Provides information about the prompts for the specified Amazon Connect
instance.
|
ListQueueQuickConnectsResult |
listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListQueuesResult |
listQueues(ListQueuesRequest listQueuesRequest)
Provides information about the queues for the specified Amazon Connect
instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)
Provides information about the quick connects for the specified Amazon
Connect instance.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
Lists the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Provides summary information about the routing profiles for the specified
Amazon Connect instance.
|
ListRulesResult |
listRules(ListRulesRequest listRulesRequest)
List all rules for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
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.
|
ListTaskTemplatesResult |
listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest)
Lists task templates for the specified Amazon Connect instance.
|
ListTrafficDistributionGroupsResult |
listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
Lists traffic distribution groups.
|
ListTrafficDistributionGroupUsersResult |
listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
Lists traffic distribution group users.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest listUseCasesRequest)
Lists the use cases for the integration association.
|
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.
|
MonitorContactResult |
monitorContact(MonitorContactRequest monitorContactRequest)
Initiates silent monitoring of a contact.
|
PutUserStatusResult |
putUserStatus(PutUserStatusRequest putUserStatusRequest)
Changes the current status of a user or agent in Amazon Connect.
|
void |
releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest)
Releases a phone number previously claimed to an Amazon Connect instance
or traffic distribution group.
|
ReplicateInstanceResult |
replicateInstance(ReplicateInstanceRequest replicateInstanceRequest)
Replicates an Amazon Connect instance in the specified Amazon Web
Services Region.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
When a contact is being recorded, and the recording has been suspended
using SuspendContactRecording, this API resumes recording the call or
screen.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for available phone numbers that you can claim to your Amazon
Connect instance or traffic distribution group.
|
SearchHoursOfOperationsResult |
searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
Searches the hours of operation in an Amazon Connect instance, with
optional filtering.
|
SearchPromptsResult |
searchPrompts(SearchPromptsRequest searchPromptsRequest)
Searches prompts in an Amazon Connect instance, with optional filtering.
|
SearchQueuesResult |
searchQueues(SearchQueuesRequest searchQueuesRequest)
Searches queues in an Amazon Connect instance, with optional filtering.
|
SearchQuickConnectsResult |
searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest)
Searches quick connects in an Amazon Connect instance, with optional
filtering.
|
SearchResourceTagsResult |
searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest)
Searches tags used in an Amazon Connect instance using optional search
criteria.
|
SearchRoutingProfilesResult |
searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
Searches routing profiles in an Amazon Connect instance, with optional
filtering.
|
SearchSecurityProfilesResult |
searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
Searches security profiles in an Amazon Connect instance, with optional
filtering.
|
SearchUsersResult |
searchUsers(SearchUsersRequest searchUsersRequest)
Searches users in an Amazon Connect instance, with optional filtering.
|
SearchVocabulariesResult |
searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest)
Searches for vocabularies within a specific Amazon Connect instance using
State, NameStartsWith, and
LanguageCode. |
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://connect.us-east-1.amazonaws.com").
|
void |
setRegion(com.amazonaws.regions.Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartChatContactResult |
startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a flow to start a new chat for the customer.
|
StartContactEvaluationResult |
startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest)
Starts an empty evaluation in the specified Amazon Connect instance,
using the given evaluation form for the particular contact.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact:
|
StartContactStreamingResult |
startContactStreaming(StartContactStreamingRequest startContactStreamingRequest)
Initiates real-time message streaming for a new chat contact.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
Places an outbound call to a contact, and then initiates the flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest startTaskContactRequest)
Initiates a flow to start a new task.
|
StopContactResult |
stopContact(StopContactRequest stopContactRequest)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)
Stops recording a call when a contact is being recorded.
|
StopContactStreamingResult |
stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest)
Ends message streaming on a specified contact.
|
SubmitContactEvaluationResult |
submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest)
Submits a contact evaluation in the specified Amazon Connect instance.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording the call or
screen.
|
void |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
TransferContactResult |
transferContact(TransferContactRequest transferContactRequest)
Transfers contacts from one agent or queue to another agent or queue at
any point after a contact is created.
|
void |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
|
void |
updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
UpdateContactResult |
updateContact(UpdateContactRequest updateContactRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
Creates or updates user-defined contact attributes associated with the
specified contact.
|
UpdateContactEvaluationResult |
updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest)
Updates details about a contact evaluation in the specified Amazon
Connect instance.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
Updates metadata about specified flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
Updates specified flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
Updates metadata about specified flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the flow.
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)
Updates the scheduled time of a task contact that is already scheduled.
|
UpdateEvaluationFormResult |
updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest)
Updates details about a specific evaluation form version in the specified
Amazon Connect instance.
|
void |
updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
UpdateParticipantRoleConfigResult |
updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)
Updates timeouts for when human chat participants are to be considered
idle, and when agents are automatically disconnected from a chat due to
idleness.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates your claimed phone number from its current Amazon Connect
instance or traffic distribution group to another Amazon Connect instance
or traffic distribution group in the same Amazon Web Services Region.
|
UpdatePromptResult |
updatePrompt(UpdatePromptRequest updatePromptRequest)
Updates a prompt.
|
void |
updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQueueName(UpdateQueueNameRequest updateQueueNameRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
Updates the configuration settings for the specified quick connect.
|
void |
updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
Updates the name and description of a quick connect.
|
void |
updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)
Whether agents with this routing profile will have their routing order
calculated based on time since their last inbound contact or
longest idle time.
|
void |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
Updates the channels that agents can handle in the Contact Control Panel
(CCP) for a routing profile.
|
void |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
Updates the default outbound queue of a routing profile.
|
void |
updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
Updates the name and description of a routing profile.
|
void |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
Updates the properties associated with a set of queues for a routing
profile.
|
void |
updateRule(UpdateRuleRequest updateRuleRequest)
Updates a rule for the specified Amazon Connect instance.
|
void |
updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
UpdateTaskTemplateResult |
updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest)
Updates details about a specific task template in the specified Amazon
Connect instance.
|
UpdateTrafficDistributionResult |
updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)
Updates the traffic distribution for a given traffic distribution group.
|
void |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the specified user.
|
void |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
Updates the name of the user hierarchy group.
|
void |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
Updates the user hierarchy structure: add, remove, and rename user
hierarchy levels.
|
void |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user.
|
void |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings for the specified user.
|
void |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to the specified user.
|
void |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Assigns the specified security profiles to the specified user.
|
void setEndpoint(java.lang.String endpoint)
throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex:
"connect.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://connect.us-east-1.amazonaws.com"). If the protocol is not
specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "connect.us-east-1.amazonaws.com") or a
full URL, including the protocol (ex:
"https://connect.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.java.lang.IllegalArgumentException - If any problems are detected with the
specified endpoint.void setRegion(com.amazonaws.regions.Region region)
throws java.lang.IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.java.lang.IllegalArgumentException - If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)ActivateEvaluationFormResult activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
activateEvaluationFormRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateBot(AssociateBotRequest associateBotRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
associateBotRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionLimitExceededExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
associateDefaultVocabularyRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
associateInstanceStorageConfigRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunctionRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateLexBot(AssociateLexBotRequest associateLexBotRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
associateLexBotRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in the
alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID
is provided in this scenario, you will receive a
ResourceNotFoundException.
associatePhoneNumberContactFlowRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Associates a set of queues with a routing profile.
associateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateTrafficDistributionGroupUserResult associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserRequest - InvalidRequestExceptionAccessDeniedExceptionThrottlingExceptionResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
claimPhoneNumberRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionIdempotencyExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowRequest - InvalidRequestExceptionInvalidContactFlowExceptionInvalidParameterExceptionDuplicateResourceExceptionLimitExceededExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModuleRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidContactFlowModuleExceptionInvalidParameterExceptionDuplicateResourceExceptionLimitExceededExceptionResourceNotFoundExceptionThrottlingExceptionIdempotencyExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateEvaluationFormResult createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
createEvaluationFormRequest - InternalServiceExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
createInstanceRequest - InvalidRequestExceptionServiceQuotaExceededExceptionThrottlingExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationRequest - DuplicateResourceExceptionResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateParticipantResult createParticipant(CreateParticipantRequest createParticipantRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionServiceQuotaExceededExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreatePromptResult createPrompt(CreatePromptRequest createPromptRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.
createPromptRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateQueueResult createQueue(CreateQueueRequest createQueueRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the number being used in the input is claimed to a traffic
distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was
created, you can use either a full phone number ARN or UUID value for the
OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number
is claimed to a traffic distribution group and you are calling this API
using an instance in the alternate Amazon Web Services Region associated
with the traffic distribution group, you must provide a full phone number
ARN. If a UUID is provided in this scenario, you will receive a
ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain
instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This
is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
createQueueRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new routing profile.
createRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateRuleResult createRule(CreateRuleRequest createRuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptionResourceConflictExceptionServiceQuotaExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates a security profile.
createSecurityProfileRequest - InvalidRequestExceptionInvalidParameterExceptionLimitExceededExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplateRequest - PropertyValidationExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateTrafficDistributionGroupResult createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
createTrafficDistributionGroupRequest - InvalidRequestExceptionAccessDeniedExceptionServiceQuotaExceededExceptionThrottlingExceptionResourceNotFoundExceptionInternalServiceExceptionResourceConflictExceptionResourceNotReadyExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a use case for an integration association.
createUseCaseRequest - DuplicateResourceExceptionResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUserResult createUser(CreateUserRequest createUserRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
createUserRequest - InvalidRequestExceptionInvalidParameterExceptionLimitExceededExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new user hierarchy group.
createUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionLimitExceededExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
createVocabularyRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptionResourceConflictExceptionServiceQuotaExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeactivateEvaluationFormResult deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
deactivateEvaluationFormRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlowRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the specified flow module.
deleteContactFlowModuleRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
deleteEvaluationFormRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
deleteInstanceRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deletePrompt(DeletePromptRequest deletePromptRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a prompt.
deletePromptRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteQueue(DeleteQueueRequest deleteQueueRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a queue.
deleteQueueRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a quick connect.
deleteQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a routing profile.
deleteRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteRule(DeleteRuleRequest deleteRuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a rule for the specified Amazon Connect instance.
deleteRuleRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes a security profile.
deleteSecurityProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptionResourceInUseExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the task template.
deleteTaskTemplateRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
deleteTrafficDistributionGroupRequest - InvalidRequestExceptionAccessDeniedExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a use case from an integration association.
deleteUseCaseRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUser(DeleteUserRequest deleteUserRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
deleteUserRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the vocabulary that has the given identifier.
deleteVocabularyRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptionResourceInUseExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeContactResult describeContact(DescribeContactRequest describeContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
describeContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeContactEvaluationResult describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
describeContactFlowRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionContactFlowNotPublishedExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified flow module.
describeContactFlowModuleRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeEvaluationFormResult describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
describeEvaluationFormRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstanceRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribePhoneNumberResult describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are
calling in the Amazon Web Services Region where the traffic distribution
group was created, you can use either a phone number ARN or UUID value
for the PhoneNumberId URI request parameter. However, if the
number is claimed to a traffic distribution group and you are calling
this API in the alternate Amazon Web Services Region associated with the
traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a
ResourceNotFoundException.
describePhoneNumberRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribePromptResult describePrompt(DescribePromptRequest describePromptRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the prompt.
describePromptRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeQueueResult describeQueue(DescribeQueueRequest describeQueueRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the quick connect.
describeQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified routing profile.
describeRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes a rule for the specified Amazon Connect instance.
describeRuleRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Gets basic information about the security profle.
describeSecurityProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroupRequest - InvalidRequestExceptionAccessDeniedExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified user account. You can find the instance ID in the Amazon Connect 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.
describeUserRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified hierarchy group.
describeUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the specified vocabulary.
describeVocabularyRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateBot(DisassociateBotRequest disassociateBotRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
disassociateBotRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
disassociateLambdaFunctionRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBotRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in the
alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID
is provided in this scenario, you will receive a
ResourceNotFoundException.
disassociatePhoneNumberContactFlowRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DisassociateTrafficDistributionGroupUserResult disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserRequest - InvalidRequestExceptionAccessDeniedExceptionThrottlingExceptionResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DismissUserContactResult dismissUserContact(DismissUserContactRequest dismissUserContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Dismisses contacts from an agent’s CCP and returns the agent to an
available state, which allows the agent to receive a new routed contact.
Contacts can only be dismissed if they are in a MISSED,
ERROR, ENDED, or REJECTED state in
the Agent Event Stream.
dismissUserContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Retrieves the contact attributes for the specified contact.
getContactAttributesRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
getCurrentMetricDataRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Retrieves a token for federation.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
getFederationTokenRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionUserNotFoundExceptionInternalServiceExceptionDuplicateResourceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
getMetricDataRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetMetricDataV2Result getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics,
offers filtering at a metric level, and offers the ability to filter and
group data by channels, queues, routing profiles, agents, and agent
hierarchy levels. It can retrieve historical data for the last 35 days,
in 24-hour intervals.
For a description of the historical metrics that are supported by
GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect
Administrator's Guide.
getMetricDataV2Request - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetPromptFileResult getPromptFile(GetPromptFileRequest getPromptFileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the prompt file.
getPromptFileRequest - InvalidParameterExceptionInvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetTrafficDistributionResult getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionRequest - InvalidRequestExceptionAccessDeniedExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOriginsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListBotsResult listBots(ListBotsRequest listBotsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
listBotsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListContactEvaluationsResult listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
listContactFlowsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListContactReferencesResult listContactReferences(ListContactReferencesRequest listContactReferencesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of
references associated with the contact.
listContactReferencesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesRequest - InvalidRequestExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListEvaluationFormVersionsResult listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListEvaluationFormsResult listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
listHoursOfOperationsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributesRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstancesRequest - InvalidRequestExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
listLambdaFunctionsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
listLexBotsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
The phone number Arn value that is returned from each of the
items in the PhoneNumberSummaryList cannot be used to tag phone number resources.
It will fail with a ResourceNotFoundException. Instead, use
the ListPhoneNumbersV2 API. It returns the new phone number ARN that can
be used to tag phone number resources.
listPhoneNumbersRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists phone numbers claimed to your Amazon Connect instance or traffic
distribution group. If the provided TargetArn is a traffic
distribution group, you can call this API in both Amazon Web Services
Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2 returns only
the phone numbers claimed to the instance.
When given a traffic distribution group ARN
ListPhoneNumbersV2 returns only the phone numbers claimed to
the traffic distribution group.
listPhoneNumbersV2Request - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides information about the prompts for the specified Amazon Connect instance.
listPromptsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard
and agent queues are returned. This might cause an unexpected truncation
of results if you have more than 1000 agents and you limit the number of
results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the queues associated with a routing profile.
listRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
listRoutingProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListRulesResult listRules(ListRulesRequest listRulesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
List all rules for the specified Amazon Connect instance.
listRulesRequest - InvalidRequestExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeysRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Lists the permissions granted to a security profile.
listSecurityProfilePermissionsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
listSecurityProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
listTagsForResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists task templates for the specified Amazon Connect instance.
listTaskTemplatesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListTrafficDistributionGroupUsersResult listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists traffic distribution group users.
listTrafficDistributionGroupUsersRequest - ResourceNotFoundExceptionInvalidRequestExceptionAccessDeniedExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListTrafficDistributionGroupsResult listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists traffic distribution groups.
listTrafficDistributionGroupsRequest - InvalidRequestExceptionAccessDeniedExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the use cases for the integration association.
listUseCasesRequest - Provides summary information about the use cases for the specified integration association.
ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
listUserHierarchyGroupsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides summary information about the users for the specified Amazon Connect instance.
listUsersRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.MonitorContactResult monitorContact(MonitorContactRequest monitorContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
monitorContactRequest - InvalidRequestExceptionIdempotencyExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.PutUserStatusResult putUserStatus(PutUserStatusRequest putUserStatusRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
putUserStatusRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the
ReleasePhoneNumber API, not the Amazon Connect console.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
releasePhoneNumberRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceInUseExceptionIdempotencyExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest replicateInstanceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
replicateInstanceRequest - InvalidRequestExceptionAccessDeniedExceptionServiceQuotaExceededExceptionThrottlingExceptionResourceNotFoundExceptionInternalServiceExceptionResourceNotReadyExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call or screen.
Voice and screen recordings are supported.
resumeContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches for available phone numbers that you can claim to your Amazon
Connect instance or traffic distribution group. If the provided
TargetArn is a traffic distribution group, you can call this
API in both Amazon Web Services Regions associated with the traffic
distribution group.
searchAvailablePhoneNumbersRequest - InvalidParameterExceptionThrottlingExceptionInternalServiceExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchHoursOfOperationsResult searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchPromptsResult searchPrompts(SearchPromptsRequest searchPromptsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchQueuesResult searchQueues(SearchQueuesRequest searchQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchQuickConnectsResult searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionMaximumResultReturnedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Searches for vocabularies within a specific Amazon Connect instance using
State, NameStartsWith, and
LanguageCode.
searchVocabulariesRequest - InvalidRequestExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates a 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 must 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 the following situations:
API rate limit is exceeded. API TPS throttling returns a
TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat
throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a
400 error, your account may not support the ability to configure custom
chat durations. For more information, contact Amazon Web Services
Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
startChatContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartContactEvaluationResult startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
startContactEvaluationRequest - InternalServiceExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API 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.
startContactRecordingRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartContactStreamingResult startContactStreaming(StartContactStreamingRequest startContactStreamingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
startContactStreamingRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Places an outbound call to a contact, and then initiates the flow. It
performs the actions in the flow that's specified (in
ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then 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.
Campaign calls are not allowed by default. Before you can make a call
with TrafficType = CAMPAIGN, you must submit a
service quota increase request to the quota Amazon Connect campaigns.
startOutboundVoiceContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptionDestinationNotAllowedExceptionOutboundContactNotPermittedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates a flow to start a new task.
startTaskContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StopContactResult stopContact(StopContactRequest stopContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Ends the specified contact. This call does not work for the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
stopContactRequest - InvalidRequestExceptionContactNotFoundExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Stops recording a call when a contact is being recorded. 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.
stopContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SubmitContactEvaluationResult submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Submits a contact evaluation in the specified Amazon Connect instance.
Answers included in the request are merged with existing answers for the
given evaluation. If no answers or notes are passed, the evaluation is
submitted with the existing answers and notes. You can delete an answer
or note by passing an empty object ({}) to the question
identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
submitContactEvaluationRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
When a contact is being recorded, this API suspends recording the call or screen. For example, you might suspend the call or screen 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.
Voice and screen recordings are supported.
suspendContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void tagResource(TagResourceRequest tagResourceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.TransferContactResult transferContact(TransferContactRequest transferContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same
call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active
contacts.
A contact cannot be transferred more than 11 times.
transferContactRequest - InvalidRequestExceptionIdempotencyExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void untagResource(UntagResourceRequest untagResourceRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Removes the specified tags from the specified resource.
untagResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactResult updateContact(UpdateContactRequest updateContactRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
updateContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display 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 to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
updateContactAttributesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactEvaluationResult updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates details about a contact evaluation in the specified Amazon
Connect instance. A contact evaluation must be in draft state. Answers
included in the request are merged with existing answers for the given
evaluation. An answer or note can be deleted by passing an empty object (
{}) to the question identifier.
updateContactEvaluationRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowContentRequest - InvalidRequestExceptionInvalidContactFlowExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates metadata about specified flow.
updateContactFlowMetadataRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates specified flow module for the specified Amazon Connect instance.
updateContactFlowModuleContentRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidContactFlowModuleExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates metadata about specified flow module.
updateContactFlowModuleMetadataRequest - AccessDeniedExceptionInvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the scheduled time of a task contact that is already scheduled.
updateContactScheduleRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionLimitExceededExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateEvaluationFormResult updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
updateEvaluationFormRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionServiceQuotaExceededExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateParticipantRoleConfigResult updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
updateParticipantRoleConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumberRequest - InvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionResourceInUseExceptionIdempotencyExceptionAccessDeniedExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdatePromptResult updatePrompt(UpdatePromptRequest updatePromptRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates a prompt.
updatePromptRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
updateQueueMaxContactsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQueueName(UpdateQueueNameRequest updateQueueNameRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or Description must be provided.
updateQueueNameRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the number being used in the input is claimed to a traffic
distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was
created, you can use either a full phone number ARN or UUID value for the
OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number
is claimed to a traffic distribution group and you are calling this API
using an instance in the alternate Amazon Web Services Region associated
with the traffic distribution group, you must provide a full phone number
ARN. If a UUID is provided in this scenario, you will receive a
ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain
instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This
is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
updateQueueOutboundCallerConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the name and description of a quick connect. The request accepts
the following data in JSON format. At least Name or
Description must be provided.
updateQuickConnectNameRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
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.
updateRoutingProfileNameRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRule(UpdateRuleRequest updateRuleRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionThrottlingExceptionAccessDeniedExceptionResourceConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates a security profile.
updateSecurityProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
updateTaskTemplateRequest - PropertyValidationExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateTrafficDistributionResult updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the traffic distribution for a given traffic distribution group.
You can change the SignInConfig only for a default
TrafficDistributionGroup. If you call
UpdateTrafficDistribution with a modified
SignInConfig and a non-default
TrafficDistributionGroup, an
InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
updateTrafficDistributionRequest - InvalidRequestExceptionAccessDeniedExceptionResourceNotFoundExceptionResourceConflictExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Assigns the specified hierarchy group to the specified user.
updateUserHierarchyRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the name of the user hierarchy group.
updateUserHierarchyGroupNameRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke
UpdateUserIdentityInfo. Someone with that ability 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. For more information, see Best Practices for Security Profiles in the Amazon Connect
Administrator Guide.
updateUserIdentityInfoRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the phone configuration settings for the specified user.
updateUserPhoneConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Assigns the specified routing profile to the specified user.
updateUserRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Assigns the specified security profiles to the specified user.
updateUserSecurityProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void shutdown()
com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.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 a request.
request - The originally executed request.