@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectClient extends AmazonWebServiceClient implements AmazonConnect
Amazon Connect is a cloud-based contact center solution that 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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
ActivateEvaluationFormResult |
activateEvaluationForm(ActivateEvaluationFormRequest request)
Activates an evaluation form in the specified Amazon Connect instance.
|
AssociateApprovedOriginResult |
associateApprovedOrigin(AssociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateBotResult |
associateBot(AssociateBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateDefaultVocabularyResult |
associateDefaultVocabulary(AssociateDefaultVocabularyRequest request)
Associates an existing vocabulary as the default.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLambdaFunctionResult |
associateLambdaFunction(AssociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLexBotResult |
associateLexBot(AssociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociatePhoneNumberContactFlowResult |
associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest request)
Associates a flow with a phone number claimed to your Amazon Connect instance.
|
AssociateQueueQuickConnectsResult |
associateQueueQuickConnects(AssociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateTrafficDistributionGroupUserResult |
associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest request)
Associates an agent with a traffic distribution group.
|
static AmazonConnectClientBuilder |
builder() |
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest request)
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest request)
Creates a flow module for the specified Amazon Connect instance.
|
CreateEvaluationFormResult |
createEvaluationForm(CreateEvaluationFormRequest request)
Creates an evaluation form in the specified Amazon Connect instance.
|
CreateHoursOfOperationResult |
createHoursOfOperation(CreateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest request)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
|
CreateParticipantResult |
createParticipant(CreateParticipantRequest request)
Adds a new participant into an on-going chat contact.
|
CreatePromptResult |
createPrompt(CreatePromptRequest request)
Creates a prompt.
|
CreateQueueResult |
createQueue(CreateQueueRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest request)
Creates a quick connect for the specified Amazon Connect instance.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
|
CreateRuleResult |
createRule(CreateRuleRequest request)
Creates a rule for the specified Amazon Connect instance.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateTaskTemplateResult |
createTaskTemplate(CreateTaskTemplateRequest request)
Creates a new task template in the specified Amazon Connect instance.
|
CreateTrafficDistributionGroupResult |
createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest request)
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest request)
Creates a use case for an integration association.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest request)
Creates a custom vocabulary associated with your Amazon Connect instance.
|
DeactivateEvaluationFormResult |
deactivateEvaluationForm(DeactivateEvaluationFormRequest request)
Deactivates an evaluation form in the specified Amazon Connect instance.
|
DeleteContactEvaluationResult |
deleteContactEvaluation(DeleteContactEvaluationRequest request)
Deletes a contact evaluation in the specified Amazon Connect instance.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest request)
Deletes a flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest request)
Deletes the specified flow module.
|
DeleteEvaluationFormResult |
deleteEvaluationForm(DeleteEvaluationFormRequest request)
Deletes an evaluation form in the specified Amazon Connect instance.
|
DeleteHoursOfOperationResult |
deleteHoursOfOperation(DeleteHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteIntegrationAssociationResult |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
|
DeletePromptResult |
deletePrompt(DeletePromptRequest request)
Deletes a prompt.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest request)
Deletes a queue.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest request)
Deletes a quick connect.
|
DeleteRoutingProfileResult |
deleteRoutingProfile(DeleteRoutingProfileRequest request)
Deletes a routing profile.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest request)
Deletes a rule for the specified Amazon Connect instance.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteTaskTemplateResult |
deleteTaskTemplate(DeleteTaskTemplateRequest request)
Deletes the task template.
|
DeleteTrafficDistributionGroupResult |
deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest request)
Deletes a traffic distribution group.
|
DeleteUseCaseResult |
deleteUseCase(DeleteUseCaseRequest request)
Deletes a use case from an integration association.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
|
DeleteUserHierarchyGroupResult |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
Deletes an existing user hierarchy group.
|
DeleteVocabularyResult |
deleteVocabulary(DeleteVocabularyRequest request)
Deletes the vocabulary that has the given identifier.
|
DescribeAgentStatusResult |
describeAgentStatus(DescribeAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactResult |
describeContact(DescribeContactRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactEvaluationResult |
describeContactEvaluation(DescribeContactEvaluationRequest request)
Describes a contact evaluation in the specified Amazon Connect instance.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest request)
Describes the specified flow module.
|
DescribeEvaluationFormResult |
describeEvaluationForm(DescribeEvaluationFormRequest request)
Describes an evaluation form in the specified Amazon Connect instance.
|
DescribeHoursOfOperationResult |
describeHoursOfOperation(DescribeHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribePhoneNumberResult |
describePhoneNumber(DescribePhoneNumberRequest request)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution
group.
|
DescribePromptResult |
describePrompt(DescribePromptRequest request)
Describes the prompt.
|
DescribeQueueResult |
describeQueue(DescribeQueueRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest request)
Describes the quick connect.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
|
DescribeRuleResult |
describeRule(DescribeRuleRequest request)
Describes a rule for the specified Amazon Connect instance.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeTrafficDistributionGroupResult |
describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest request)
Gets details and status of a traffic distribution group.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DescribeVocabularyResult |
describeVocabulary(DescribeVocabularyRequest request)
Describes the specified vocabulary.
|
DisassociateApprovedOriginResult |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateBotResult |
disassociateBot(DisassociateBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateInstanceStorageConfigResult |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLambdaFunctionResult |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLexBotResult |
disassociateLexBot(DisassociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociatePhoneNumberContactFlowResult |
disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest request)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
|
DisassociateQueueQuickConnectsResult |
disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
|
DisassociateSecurityKeyResult |
disassociateSecurityKey(DisassociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateTrafficDistributionGroupUserResult |
disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest request)
Disassociates an agent from a traffic distribution group.
|
DismissUserContactResult |
dismissUserContact(DismissUserContactRequest request)
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.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContactAttributesResult |
getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetCurrentUserDataResult |
getCurrentUserData(GetCurrentUserDataRequest request)
Gets the real-time active user data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
GetMetricDataV2Result |
getMetricDataV2(GetMetricDataV2Request request)
Gets metric data from the specified Amazon Connect instance.
|
GetPromptFileResult |
getPromptFile(GetPromptFileRequest request)
Gets the prompt file.
|
GetTaskTemplateResult |
getTaskTemplate(GetTaskTemplateRequest request)
Gets details about a specific task template in the specified Amazon Connect instance.
|
GetTrafficDistributionResult |
getTrafficDistribution(GetTrafficDistributionRequest request)
Retrieves the current traffic distribution for a given traffic distribution group.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListBotsResult |
listBots(ListBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListContactEvaluationsResult |
listContactEvaluations(ListContactEvaluationsRequest request)
Lists contact evaluations in the specified Amazon Connect instance.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest request)
Provides information about the flow modules for the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the flows for the specified Amazon Connect instance.
|
ListContactReferencesResult |
listContactReferences(ListContactReferencesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListDefaultVocabulariesResult |
listDefaultVocabularies(ListDefaultVocabulariesRequest request)
Lists the default vocabularies for the specified Amazon Connect instance.
|
ListEvaluationFormsResult |
listEvaluationForms(ListEvaluationFormsRequest request)
Lists evaluation forms in the specified Amazon Connect instance.
|
ListEvaluationFormVersionsResult |
listEvaluationFormVersions(ListEvaluationFormVersionsRequest request)
Lists versions of an evaluation form in the specified Amazon Connect instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest request)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect
instance.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListPhoneNumbersV2Result |
listPhoneNumbersV2(ListPhoneNumbersV2Request request)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
|
ListPromptsResult |
listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueueQuickConnectsResult |
listQueueQuickConnects(ListQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest request)
Provides information about the quick connects for the specified Amazon Connect instance.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
Lists the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListRulesResult |
listRules(ListRulesRequest request)
List all rules for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListTaskTemplatesResult |
listTaskTemplates(ListTaskTemplatesRequest request)
Lists task templates for the specified Amazon Connect instance.
|
ListTrafficDistributionGroupsResult |
listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest request)
Lists traffic distribution groups.
|
ListTrafficDistributionGroupUsersResult |
listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest request)
Lists traffic distribution group users.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest request)
Lists the use cases for the integration association.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
MonitorContactResult |
monitorContact(MonitorContactRequest request)
Initiates silent monitoring of a contact.
|
PutUserStatusResult |
putUserStatus(PutUserStatusRequest request)
Changes the current status of a user or agent in Amazon Connect.
|
ReleasePhoneNumberResult |
releasePhoneNumber(ReleasePhoneNumberRequest request)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
|
ReplicateInstanceResult |
replicateInstance(ReplicateInstanceRequest request)
Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
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 request)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group.
|
SearchHoursOfOperationsResult |
searchHoursOfOperations(SearchHoursOfOperationsRequest request)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
|
SearchPromptsResult |
searchPrompts(SearchPromptsRequest request)
Searches prompts in an Amazon Connect instance, with optional filtering.
|
SearchQueuesResult |
searchQueues(SearchQueuesRequest request)
Searches queues in an Amazon Connect instance, with optional filtering.
|
SearchQuickConnectsResult |
searchQuickConnects(SearchQuickConnectsRequest request)
Searches quick connects in an Amazon Connect instance, with optional filtering.
|
SearchResourceTagsResult |
searchResourceTags(SearchResourceTagsRequest request)
Searches tags used in an Amazon Connect instance using optional search criteria.
|
SearchRoutingProfilesResult |
searchRoutingProfiles(SearchRoutingProfilesRequest request)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
|
SearchSecurityProfilesResult |
searchSecurityProfiles(SearchSecurityProfilesRequest request)
Searches security profiles in an Amazon Connect instance, with optional filtering.
|
SearchUsersResult |
searchUsers(SearchUsersRequest request)
Searches users in an Amazon Connect instance, with optional filtering.
|
SearchVocabulariesResult |
searchVocabularies(SearchVocabulariesRequest request)
Searches for vocabularies within a specific Amazon Connect instance using
State ,
NameStartsWith , and LanguageCode . |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartChatContactResult |
startChatContact(StartChatContactRequest request)
Initiates a flow to start a new chat for the customer.
|
StartContactEvaluationResult |
startContactEvaluation(StartContactEvaluationRequest request)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the
particular contact.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest request)
Starts recording the contact:
|
StartContactStreamingResult |
startContactStreaming(StartContactStreamingRequest request)
Initiates real-time message streaming for a new chat contact.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
Places an outbound call to a contact, and then initiates the flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest request)
Initiates a flow to start a new task.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest request)
Stops recording a call when a contact is being recorded.
|
StopContactStreamingResult |
stopContactStreaming(StopContactStreamingRequest request)
Ends message streaming on a specified contact.
|
SubmitContactEvaluationResult |
submitContactEvaluation(SubmitContactEvaluationRequest request)
Submits a contact evaluation in the specified Amazon Connect instance.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call or screen.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
TransferContactResult |
transferContact(TransferContactRequest request)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
|
UpdateAgentStatusResult |
updateAgentStatus(UpdateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactResult |
updateContact(UpdateContactRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest request)
Creates or updates user-defined contact attributes associated with the specified contact.
|
UpdateContactEvaluationResult |
updateContactEvaluation(UpdateContactEvaluationRequest request)
Updates details about a contact evaluation in the specified Amazon Connect instance.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
Updates metadata about specified flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
Updates specified flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
Updates metadata about specified flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the flow.
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest request)
Updates the scheduled time of a task contact that is already scheduled.
|
UpdateEvaluationFormResult |
updateEvaluationForm(UpdateEvaluationFormRequest request)
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
|
UpdateHoursOfOperationResult |
updateHoursOfOperation(UpdateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceAttributeResult |
updateInstanceAttribute(UpdateInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceStorageConfigResult |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateParticipantRoleConfigResult |
updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest request)
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 request)
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 request)
Updates a prompt.
|
UpdateQueueHoursOfOperationResult |
updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueMaxContactsResult |
updateQueueMaxContacts(UpdateQueueMaxContactsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueNameResult |
updateQueueName(UpdateQueueNameRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueOutboundCallerConfigResult |
updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueStatusResult |
updateQueueStatus(UpdateQueueStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQuickConnectConfigResult |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
Updates the configuration settings for the specified quick connect.
|
UpdateQuickConnectNameResult |
updateQuickConnectName(UpdateQuickConnectNameRequest request)
Updates the name and description of a quick connect.
|
UpdateRoutingProfileAgentAvailabilityTimerResult |
updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest request)
Whether agents with this routing profile will have their routing order calculated based on time since their
last inbound contact or longest idle time.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
|
UpdateRuleResult |
updateRule(UpdateRuleRequest request)
Updates a rule for the specified Amazon Connect instance.
|
UpdateSecurityProfileResult |
updateSecurityProfile(UpdateSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateTaskTemplateResult |
updateTaskTemplate(UpdateTaskTemplateRequest request)
Updates details about a specific task template in the specified Amazon Connect instance.
|
UpdateTrafficDistributionResult |
updateTrafficDistribution(UpdateTrafficDistributionRequest request)
Updates the traffic distribution for a given traffic distribution group.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserHierarchyGroupNameResult |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
|
UpdateUserHierarchyStructureResult |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonConnectClientBuilder builder()
public ActivateEvaluationFormResult activateEvaluationForm(ActivateEvaluationFormRequest request)
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.
activateEvaluationForm
in interface AmazonConnect
activateEvaluationFormRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOrigin
in interface AmazonConnect
associateApprovedOriginRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateBotResult associateBot(AssociateBotRequest request)
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.
associateBot
in interface AmazonConnect
associateBotRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.LimitExceededException
- The allowed limit for the resource has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest request)
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.
associateDefaultVocabulary
in interface AmazonConnect
associateDefaultVocabularyRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
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.
associateInstanceStorageConfig
in interface AmazonConnect
associateInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest request)
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.
associateLambdaFunction
in interface AmazonConnect
associateLambdaFunctionRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateLexBotResult associateLexBot(AssociateLexBotRequest request)
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.
associateLexBot
in interface AmazonConnect
associateLexBotRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociatePhoneNumberContactFlowResult associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest request)
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
.
associatePhoneNumberContactFlow
in interface AmazonConnect
associatePhoneNumberContactFlowRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.public AssociateQueueQuickConnectsResult associateQueueQuickConnects(AssociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnects
in interface AmazonConnect
associateQueueQuickConnectsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
associateRoutingProfileQueues
in interface AmazonConnect
associateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKey
in interface AmazonConnect
associateSecurityKeyRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateTrafficDistributionGroupUserResult associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest request)
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUser
in interface AmazonConnect
associateTrafficDistributionGroupUserRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.public ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest request)
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.
claimPhoneNumber
in interface AmazonConnect
claimPhoneNumberRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.IdempotencyException
- An entity with the same name already exists.AccessDeniedException
- You do not have sufficient permissions to perform this action.public CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatus
in interface AmazonConnect
createAgentStatusRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlow
in interface AmazonConnect
createContactFlowRequest
- InvalidRequestException
- The request is not valid.InvalidContactFlowException
- The flow is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.LimitExceededException
- The allowed limit for the resource has been exceeded.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest request)
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModule
in interface AmazonConnect
createContactFlowModuleRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidContactFlowModuleException
- The problems with the module. Please fix before trying again.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.LimitExceededException
- The allowed limit for the resource has been exceeded.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.IdempotencyException
- An entity with the same name already exists.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateEvaluationFormResult createEvaluationForm(CreateEvaluationFormRequest request)
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.
createEvaluationForm
in interface AmazonConnect
createEvaluationFormRequest
- InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.ResourceConflictException
- A resource already has that name.public CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperation
in interface AmazonConnect
createHoursOfOperationRequest
- DuplicateResourceException
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateInstanceResult createInstance(CreateInstanceRequest request)
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.
createInstance
in interface AmazonConnect
createInstanceRequest
- InvalidRequestException
- The request is not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest request)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociation
in interface AmazonConnect
createIntegrationAssociationRequest
- DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public CreateParticipantResult createParticipant(CreateParticipantRequest request)
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipant
in interface AmazonConnect
createParticipantRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public CreatePromptResult createPrompt(CreatePromptRequest request)
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.
createPrompt
in interface AmazonConnect
createPromptRequest
- DuplicateResourceException
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateQueueResult createQueue(CreateQueueRequest request)
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.
createQueue
in interface AmazonConnect
createQueueRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest request)
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnect
in interface AmazonConnect
createQuickConnectRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
createRoutingProfile
in interface AmazonConnect
createRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateRuleResult createRule(CreateRuleRequest request)
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRule
in interface AmazonConnect
createRuleRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceConflictException
- A resource already has that name.ServiceQuotaExceededException
- The service quota has been exceeded.public CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Creates a security profile.
createSecurityProfile
in interface AmazonConnect
createSecurityProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.LimitExceededException
- The allowed limit for the resource has been exceeded.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest request)
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplate
in interface AmazonConnect
createTaskTemplateRequest
- PropertyValidationException
- The property is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateTrafficDistributionGroupResult createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest request)
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.
createTrafficDistributionGroup
in interface AmazonConnect
createTrafficDistributionGroupRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.ResourceNotReadyException
- The resource is not ready.public CreateUseCaseResult createUseCase(CreateUseCaseRequest request)
Creates a use case for an integration association.
createUseCase
in interface AmazonConnect
createUseCaseRequest
- DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public CreateUserResult createUser(CreateUserRequest request)
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.
createUser
in interface AmazonConnect
createUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.LimitExceededException
- The allowed limit for the resource has been exceeded.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
createUserHierarchyGroup
in interface AmazonConnect
createUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.LimitExceededException
- The allowed limit for the resource has been exceeded.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)
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.
createVocabulary
in interface AmazonConnect
createVocabularyRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceConflictException
- A resource already has that name.ServiceQuotaExceededException
- The service quota has been exceeded.public DeactivateEvaluationFormResult deactivateEvaluationForm(DeactivateEvaluationFormRequest request)
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.
deactivateEvaluationForm
in interface AmazonConnect
deactivateEvaluationFormRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public DeleteContactEvaluationResult deleteContactEvaluation(DeleteContactEvaluationRequest request)
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluation
in interface AmazonConnect
deleteContactEvaluationRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest request)
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlow
in interface AmazonConnect
deleteContactFlowRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest request)
Deletes the specified flow module.
deleteContactFlowModule
in interface AmazonConnect
deleteContactFlowModuleRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteEvaluationFormResult deleteEvaluationForm(DeleteEvaluationFormRequest request)
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.
deleteEvaluationForm
in interface AmazonConnect
deleteEvaluationFormRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public DeleteHoursOfOperationResult deleteHoursOfOperation(DeleteHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperation
in interface AmazonConnect
deleteHoursOfOperationRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
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.
deleteInstance
in interface AmazonConnect
deleteInstanceRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.public DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociation
in interface AmazonConnect
deleteIntegrationAssociationRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public DeletePromptResult deletePrompt(DeletePromptRequest request)
Deletes a prompt.
deletePrompt
in interface AmazonConnect
deletePromptRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteQueueResult deleteQueue(DeleteQueueRequest request)
Deletes a queue.
deleteQueue
in interface AmazonConnect
deleteQueueRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest request)
Deletes a quick connect.
deleteQuickConnect
in interface AmazonConnect
deleteQuickConnectRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteRoutingProfileResult deleteRoutingProfile(DeleteRoutingProfileRequest request)
Deletes a routing profile.
deleteRoutingProfile
in interface AmazonConnect
deleteRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteRuleResult deleteRule(DeleteRuleRequest request)
Deletes a rule for the specified Amazon Connect instance.
deleteRule
in interface AmazonConnect
deleteRuleRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Deletes a security profile.
deleteSecurityProfile
in interface AmazonConnect
deleteSecurityProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceInUseException
- That resource is already in use. Please try another.public DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest request)
Deletes the task template.
deleteTaskTemplate
in interface AmazonConnect
deleteTaskTemplateRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest request)
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.
deleteTrafficDistributionGroup
in interface AmazonConnect
deleteTrafficDistributionGroupRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest request)
Deletes a use case from an integration association.
deleteUseCase
in interface AmazonConnect
deleteUseCaseRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public DeleteUserResult deleteUser(DeleteUserRequest request)
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.
deleteUser
in interface AmazonConnect
deleteUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroup
in interface AmazonConnect
deleteUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)
Deletes the vocabulary that has the given identifier.
deleteVocabulary
in interface AmazonConnect
deleteVocabularyRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceInUseException
- That resource is already in use. Please try another.public DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatus
in interface AmazonConnect
describeAgentStatusRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeContactResult describeContact(DescribeContactRequest request)
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.
describeContact
in interface AmazonConnect
describeContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public DescribeContactEvaluationResult describeContactEvaluation(DescribeContactEvaluationRequest request)
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluation
in interface AmazonConnect
describeContactEvaluationRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
describeContactFlow
in interface AmazonConnect
describeContactFlowRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ContactFlowNotPublishedException
- The flow has not been published.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest request)
Describes the specified flow module.
describeContactFlowModule
in interface AmazonConnect
describeContactFlowModuleRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeEvaluationFormResult describeEvaluationForm(DescribeEvaluationFormRequest request)
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.
describeEvaluationForm
in interface AmazonConnect
describeEvaluationFormRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperation
in interface AmazonConnect
describeHoursOfOperationRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
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.
describeInstance
in interface AmazonConnect
describeInstanceRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttribute
in interface AmazonConnect
describeInstanceAttributeRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
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.
describeInstanceStorageConfig
in interface AmazonConnect
describeInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DescribePhoneNumberResult describePhoneNumber(DescribePhoneNumberRequest request)
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
.
describePhoneNumber
in interface AmazonConnect
describePhoneNumberRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.public DescribePromptResult describePrompt(DescribePromptRequest request)
Describes the prompt.
describePrompt
in interface AmazonConnect
describePromptRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeQueueResult describeQueue(DescribeQueueRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueue
in interface AmazonConnect
describeQueueRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest request)
Describes the quick connect.
describeQuickConnect
in interface AmazonConnect
describeQuickConnectRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
describeRoutingProfile
in interface AmazonConnect
describeRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeRuleResult describeRule(DescribeRuleRequest request)
Describes a rule for the specified Amazon Connect instance.
describeRule
in interface AmazonConnect
describeRuleRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Gets basic information about the security profle.
describeSecurityProfile
in interface AmazonConnect
describeSecurityProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest request)
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroup
in interface AmazonConnect
describeTrafficDistributionGroupRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public DescribeUserResult describeUser(DescribeUserRequest request)
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.
describeUser
in interface AmazonConnect
describeUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
describeUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
describeUserHierarchyStructureRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest request)
Describes the specified vocabulary.
describeVocabulary
in interface AmazonConnect
describeVocabularyRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin
in interface AmazonConnect
disassociateApprovedOriginRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateBotResult disassociateBot(DisassociateBotRequest request)
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.
disassociateBot
in interface AmazonConnect
disassociateBotRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
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.
disassociateInstanceStorageConfig
in interface AmazonConnect
disassociateInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
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.
disassociateLambdaFunction
in interface AmazonConnect
disassociateLambdaFunctionRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest request)
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.
disassociateLexBot
in interface AmazonConnect
disassociateLexBotRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociatePhoneNumberContactFlowResult disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest request)
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
.
disassociatePhoneNumberContactFlow
in interface AmazonConnect
disassociatePhoneNumberContactFlowRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.public DisassociateQueueQuickConnectsResult disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnects
in interface AmazonConnect
disassociateQueueQuickConnectsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues
in interface AmazonConnect
disassociateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKey
in interface AmazonConnect
disassociateSecurityKeyRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateTrafficDistributionGroupUserResult disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest request)
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUser
in interface AmazonConnect
disassociateTrafficDistributionGroupUserRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed because of an error or failure with the service.public DismissUserContactResult dismissUserContact(DismissUserContactRequest request)
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.
dismissUserContact
in interface AmazonConnect
dismissUserContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServiceException
- Request processing failed because of an error or failure with the service.public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
getContactAttributesRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricData
in interface AmazonConnect
getCurrentMetricDataRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest request)
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserData
in interface AmazonConnect
getCurrentUserDataRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
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
getFederationToken
in interface AmazonConnect
getFederationTokenRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.UserNotFoundException
- No user with the specified credentials was found in the Amazon Connect instance.InternalServiceException
- Request processing failed because of an error or failure with the service.DuplicateResourceException
- A resource with the specified name already exists.public GetMetricDataResult getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
getMetricData
in interface AmazonConnect
getMetricDataRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public GetMetricDataV2Result getMetricDataV2(GetMetricDataV2Request request)
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.
getMetricDataV2
in interface AmazonConnect
getMetricDataV2Request
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public GetPromptFileResult getPromptFile(GetPromptFileRequest request)
Gets the prompt file.
getPromptFile
in interface AmazonConnect
getPromptFileRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest request)
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplate
in interface AmazonConnect
getTaskTemplateRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public GetTrafficDistributionResult getTrafficDistribution(GetTrafficDistributionRequest request)
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistribution
in interface AmazonConnect
getTrafficDistributionRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatuses
in interface AmazonConnect
listAgentStatusesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest request)
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.
listApprovedOrigins
in interface AmazonConnect
listApprovedOriginsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListBotsResult listBots(ListBotsRequest request)
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.
listBots
in interface AmazonConnect
listBotsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public ListContactEvaluationsResult listContactEvaluations(ListContactEvaluationsRequest request)
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluations
in interface AmazonConnect
listContactEvaluationsRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest request)
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModules
in interface AmazonConnect
listContactFlowModulesRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
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.
listContactFlows
in interface AmazonConnect
listContactFlowsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListContactReferencesResult listContactReferences(ListContactReferencesRequest request)
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.
listContactReferences
in interface AmazonConnect
listContactReferencesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest request)
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabularies
in interface AmazonConnect
listDefaultVocabulariesRequest
- InvalidRequestException
- The request is not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public ListEvaluationFormVersionsResult listEvaluationFormVersions(ListEvaluationFormVersionsRequest request)
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersions
in interface AmazonConnect
listEvaluationFormVersionsRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListEvaluationFormsResult listEvaluationForms(ListEvaluationFormsRequest request)
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationForms
in interface AmazonConnect
listEvaluationFormsRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperations
in interface AmazonConnect
listHoursOfOperationsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest request)
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.
listInstanceAttributes
in interface AmazonConnect
listInstanceAttributesRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
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.
listInstanceStorageConfigs
in interface AmazonConnect
listInstanceStorageConfigsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListInstancesResult listInstances(ListInstancesRequest request)
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.
listInstances
in interface AmazonConnect
listInstancesRequest
- InvalidRequestException
- The request is not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest request)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociations
in interface AmazonConnect
listIntegrationAssociationsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest request)
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.
listLambdaFunctions
in interface AmazonConnect
listLambdaFunctionsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListLexBotsResult listLexBots(ListLexBotsRequest request)
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.
listLexBots
in interface AmazonConnect
listLexBotsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
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.
listPhoneNumbers
in interface AmazonConnect
listPhoneNumbersRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request request)
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.
listPhoneNumbersV2
in interface AmazonConnect
listPhoneNumbersV2Request
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.public ListPromptsResult listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
listPrompts
in interface AmazonConnect
listPromptsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnects
in interface AmazonConnect
listQueueQuickConnectsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListQueuesResult listQueues(ListQueuesRequest request)
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.
listQueues
in interface AmazonConnect
listQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest request)
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnects
in interface AmazonConnect
listQuickConnectsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
Lists the queues associated with a routing profile.
listRoutingProfileQueues
in interface AmazonConnect
listRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfiles
in interface AmazonConnect
listRoutingProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListRulesResult listRules(ListRulesRequest request)
List all rules for the specified Amazon Connect instance.
listRules
in interface AmazonConnect
listRulesRequest
- InvalidRequestException
- The request is not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.public ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest request)
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.
listSecurityKeys
in interface AmazonConnect
listSecurityKeysRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Lists the permissions granted to a security profile.
listSecurityProfilePermissions
in interface AmazonConnect
listSecurityProfilePermissionsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfiles
in interface AmazonConnect
listSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AmazonConnect
listTagsForResourceRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest request)
Lists task templates for the specified Amazon Connect instance.
listTaskTemplates
in interface AmazonConnect
listTaskTemplatesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListTrafficDistributionGroupUsersResult listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest request)
Lists traffic distribution group users.
listTrafficDistributionGroupUsers
in interface AmazonConnect
listTrafficDistributionGroupUsersRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListTrafficDistributionGroupsResult listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest request)
Lists traffic distribution groups.
listTrafficDistributionGroups
in interface AmazonConnect
listTrafficDistributionGroupsRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListUseCasesResult listUseCases(ListUseCasesRequest request)
Lists the use cases for the integration association.
listUseCases
in interface AmazonConnect
listUseCasesRequest
- Provides summary information about the use cases for the specified integration association.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.ThrottlingException
- The throttling limit has been exceeded.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroups
in interface AmazonConnect
listUserHierarchyGroupsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ListUsersResult listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
listUsersRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public MonitorContactResult monitorContact(MonitorContactRequest request)
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.
monitorContact
in interface AmazonConnect
monitorContactRequest
- InvalidRequestException
- The request is not valid.IdempotencyException
- An entity with the same name already exists.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public PutUserStatusResult putUserStatus(PutUserStatusRequest request)
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.
putUserStatus
in interface AmazonConnect
putUserStatusRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServiceException
- Request processing failed because of an error or failure with the service.public ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest request)
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.
releasePhoneNumber
in interface AmazonConnect
releasePhoneNumberRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceInUseException
- That resource is already in use. Please try another.IdempotencyException
- An entity with the same name already exists.AccessDeniedException
- You do not have sufficient permissions to perform this action.public ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest request)
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.
replicateInstance
in interface AmazonConnect
replicateInstanceRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceNotReadyException
- The resource is not ready.ResourceConflictException
- A resource already has that name.public ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
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.
resumeContactRecording
in interface AmazonConnect
resumeContactRecordingRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
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.
searchAvailablePhoneNumbers
in interface AmazonConnect
searchAvailablePhoneNumbersRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.AccessDeniedException
- You do not have sufficient permissions to perform this action.public SearchHoursOfOperationsResult searchHoursOfOperations(SearchHoursOfOperationsRequest request)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperations
in interface AmazonConnect
searchHoursOfOperationsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchPromptsResult searchPrompts(SearchPromptsRequest request)
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPrompts
in interface AmazonConnect
searchPromptsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchQueuesResult searchQueues(SearchQueuesRequest request)
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueues
in interface AmazonConnect
searchQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchQuickConnectsResult searchQuickConnects(SearchQuickConnectsRequest request)
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnects
in interface AmazonConnect
searchQuickConnectsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest request)
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTags
in interface AmazonConnect
searchResourceTagsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.MaximumResultReturnedException
- Maximum number (1000) of tags have been returned with current request. Consider changing request
parameters to get more tags.public SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest request)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfiles
in interface AmazonConnect
searchRoutingProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest request)
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfiles
in interface AmazonConnect
searchSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchUsersResult searchUsers(SearchUsersRequest request)
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
searchUsers
in interface AmazonConnect
searchUsersRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest request)
Searches for vocabularies within a specific Amazon Connect instance using State
,
NameStartsWith
, and LanguageCode
.
searchVocabularies
in interface AmazonConnect
searchVocabulariesRequest
- InvalidRequestException
- The request is not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.public StartChatContactResult startChatContact(StartChatContactRequest request)
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.
startChatContact
in interface AmazonConnect
startChatContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.LimitExceededException
- The allowed limit for the resource has been exceeded.public StartContactEvaluationResult startContactEvaluation(StartContactEvaluationRequest request)
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.
startContactEvaluation
in interface AmazonConnect
startContactEvaluationRequest
- InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.ResourceConflictException
- A resource already has that name.public StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
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.
startContactRecording
in interface AmazonConnect
startContactRecordingRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public StartContactStreamingResult startContactStreaming(StartContactStreamingRequest request)
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.
startContactStreaming
in interface AmazonConnect
startContactStreamingRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.LimitExceededException
- The allowed limit for the resource has been exceeded.public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
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.
startOutboundVoiceContact
in interface AmazonConnect
startOutboundVoiceContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.LimitExceededException
- The allowed limit for the resource has been exceeded.DestinationNotAllowedException
- Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException
- The contact is not permitted.public StartTaskContactResult startTaskContact(StartTaskContactRequest request)
Initiates a flow to start a new task.
startTaskContact
in interface AmazonConnect
startTaskContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public StopContactResult stopContact(StopContactRequest request)
Ends the specified contact. This call does not work for the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
stopContact
in interface AmazonConnect
stopContactRequest
- InvalidRequestException
- The request is not valid.ContactNotFoundException
- The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to
Chat, Task, or Voice Callback.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
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.
stopContactRecording
in interface AmazonConnect
stopContactRecordingRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest request)
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreaming
in interface AmazonConnect
stopContactStreamingRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public SubmitContactEvaluationResult submitContactEvaluation(SubmitContactEvaluationRequest request)
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.
submitContactEvaluation
in interface AmazonConnect
submitContactEvaluationRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
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.
suspendContactRecording
in interface AmazonConnect
suspendContactRecordingRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonConnect
tagResourceRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public TransferContactResult transferContact(TransferContactRequest request)
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.
transferContact
in interface AmazonConnect
transferContactRequest
- InvalidRequestException
- The request is not valid.IdempotencyException
- An entity with the same name already exists.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
untagResourceRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatus
in interface AmazonConnect
updateAgentStatusRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactResult updateContact(UpdateContactRequest request)
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.
updateContact
in interface AmazonConnect
updateContactRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
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.
updateContactAttributes
in interface AmazonConnect
updateContactAttributesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactEvaluationResult updateContactEvaluation(UpdateContactEvaluationRequest request)
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.
updateContactEvaluation
in interface AmazonConnect
updateContactEvaluationRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceConflictException
- A resource already has that name.public UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowContent
in interface AmazonConnect
updateContactFlowContentRequest
- InvalidRequestException
- The request is not valid.InvalidContactFlowException
- The flow is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
Updates metadata about specified flow.
updateContactFlowMetadata
in interface AmazonConnect
updateContactFlowMetadataRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
Updates specified flow module for the specified Amazon Connect instance.
updateContactFlowModuleContent
in interface AmazonConnect
updateContactFlowModuleContentRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidContactFlowModuleException
- The problems with the module. Please fix before trying again.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
Updates metadata about specified flow module.
updateContactFlowModuleMetadata
in interface AmazonConnect
updateContactFlowModuleMetadataRequest
- AccessDeniedException
- You do not have sufficient permissions to perform this action.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowName
in interface AmazonConnect
updateContactFlowNameRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest request)
Updates the scheduled time of a task contact that is already scheduled.
updateContactSchedule
in interface AmazonConnect
updateContactScheduleRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.LimitExceededException
- The allowed limit for the resource has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateEvaluationFormResult updateEvaluationForm(UpdateEvaluationFormRequest request)
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.
updateEvaluationForm
in interface AmazonConnect
updateEvaluationFormRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ServiceQuotaExceededException
- The service quota has been exceeded.ResourceConflictException
- A resource already has that name.public UpdateHoursOfOperationResult updateHoursOfOperation(UpdateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperation
in interface AmazonConnect
updateHoursOfOperationRequest
- DuplicateResourceException
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttribute
in interface AmazonConnect
updateInstanceAttributeRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
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.
updateInstanceStorageConfig
in interface AmazonConnect
updateInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public UpdateParticipantRoleConfigResult updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest request)
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.
updateParticipantRoleConfig
in interface AmazonConnect
updateParticipantRoleConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.AccessDeniedException
- You do not have sufficient permissions to perform this action.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
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.
updatePhoneNumber
in interface AmazonConnect
updatePhoneNumberRequest
- InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.ResourceInUseException
- That resource is already in use. Please try another.IdempotencyException
- An entity with the same name already exists.AccessDeniedException
- You do not have sufficient permissions to perform this action.public UpdatePromptResult updatePrompt(UpdatePromptRequest request)
Updates a prompt.
updatePrompt
in interface AmazonConnect
updatePromptRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQueueHoursOfOperationResult updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperation
in interface AmazonConnect
updateQueueHoursOfOperationRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQueueMaxContactsResult updateQueueMaxContacts(UpdateQueueMaxContactsRequest request)
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.
updateQueueMaxContacts
in interface AmazonConnect
updateQueueMaxContactsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQueueNameResult updateQueueName(UpdateQueueNameRequest request)
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.
updateQueueName
in interface AmazonConnect
updateQueueNameRequest
- DuplicateResourceException
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQueueOutboundCallerConfigResult updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest request)
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.
updateQueueOutboundCallerConfig
in interface AmazonConnect
updateQueueOutboundCallerConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQueueStatusResult updateQueueStatus(UpdateQueueStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatus
in interface AmazonConnect
updateQueueStatusRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfig
in interface AmazonConnect
updateQuickConnectConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateQuickConnectNameResult updateQuickConnectName(UpdateQuickConnectNameRequest request)
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.
updateQuickConnectName
in interface AmazonConnect
updateQuickConnectNameRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRoutingProfileAgentAvailabilityTimerResult updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest request)
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimer
in interface AmazonConnect
updateRoutingProfileAgentAvailabilityTimerRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency
in interface AmazonConnect
updateRoutingProfileConcurrencyRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue
in interface AmazonConnect
updateRoutingProfileDefaultOutboundQueueRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At
least Name
or Description
must be provided.
updateRoutingProfileName
in interface AmazonConnect
updateRoutingProfileNameRequest
- DuplicateResourceException
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues
in interface AmazonConnect
updateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateRuleResult updateRule(UpdateRuleRequest request)
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRule
in interface AmazonConnect
updateRuleRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed because of an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceConflictException
- A resource already has that name.public UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
Updates a security profile.
updateSecurityProfile
in interface AmazonConnect
updateSecurityProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest request)
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.
updateTaskTemplate
in interface AmazonConnect
updateTaskTemplateRequest
- PropertyValidationException
- The property is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.ServiceQuotaExceededException
- The service quota has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateTrafficDistributionResult updateTrafficDistribution(UpdateTrafficDistributionRequest request)
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.
updateTrafficDistribution
in interface AmazonConnect
updateTrafficDistributionRequest
- InvalidRequestException
- The request is not valid.AccessDeniedException
- You do not have sufficient permissions to perform this action.ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
updateUserHierarchyRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
updateUserHierarchyGroupName
in interface AmazonConnect
updateUserHierarchyGroupNameRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure
in interface AmazonConnect
updateUserHierarchyStructureRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
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.
updateUserIdentityInfo
in interface AmazonConnect
updateUserIdentityInfoRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
updateUserPhoneConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
updateUserRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
updateUserSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed because of an error or failure with the service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonConnect
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonConnect
shutdown
in class AmazonWebServiceClient