@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnect extends Object implements AmazonConnect
AmazonConnect. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
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 contact 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.
|
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest request)
Claims an available phone number to your Amazon Connect instance.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest request)
Creates a contact flow module for 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.
|
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.
|
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.
|
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.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest request)
Deletes a contact flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest request)
Deletes the specified contact flow module.
|
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.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest request)
Deletes a quick connect.
|
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.
|
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.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified contact flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest request)
Describes the specified contact flow module.
|
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
|
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.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
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 contact flow association from a phone number claimed to your Amazon Connect instance, if a contact
flow association exists.
|
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.
|
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.
|
GetTaskTemplateResult |
getTaskTemplate(GetTaskTemplateRequest request)
Gets details about a specific task template in the specified Amazon Connect instance.
|
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.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest request)
Provides information about the contact flow modules for the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the contact 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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API
resumes recording the call.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
Searches for available phone numbers that you can claim to your Amazon Connect instance.
|
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 contact flow to start a new chat for the customer.
|
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 contact flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest request)
Initiates a contact 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.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
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.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified contact flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
Updates metadata about specified contact flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
Updates specified contact flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
Updates metadata about specified contact flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the contact flow.
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest request)
Updates the scheduled time of a task contact that is already scheduled.
|
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.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in
the same Region.
|
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.
|
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.
|
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.
|
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.
|
public AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest request)
AmazonConnectThis 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 AmazonConnectpublic AssociateBotResult associateBot(AssociateBotRequest request)
AmazonConnectThis 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 AmazonConnectpublic AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest request)
AmazonConnectAssociates 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 AmazonConnectpublic AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
AmazonConnectThis 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 AmazonConnectpublic AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest request)
AmazonConnectThis 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 AmazonConnectpublic AssociateLexBotResult associateLexBot(AssociateLexBotRequest request)
AmazonConnectThis 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 bot.
associateLexBot in interface AmazonConnectpublic AssociatePhoneNumberContactFlowResult associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest request)
AmazonConnectAssociates a contact flow with a phone number claimed to your Amazon Connect instance.
associatePhoneNumberContactFlow in interface AmazonConnectpublic AssociateQueueQuickConnectsResult associateQueueQuickConnects(AssociateQueueQuickConnectsRequest request)
AmazonConnectThis 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 AmazonConnectpublic AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
AmazonConnectAssociates a set of queues with a routing profile.
associateRoutingProfileQueues in interface AmazonConnectpublic AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKey in interface AmazonConnectpublic ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest request)
AmazonConnectClaims an available phone number to your Amazon Connect instance.
claimPhoneNumber in interface AmazonConnectpublic CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest request)
AmazonConnectThis 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 AmazonConnectpublic CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
AmazonConnectCreates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlow in interface AmazonConnectpublic CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest request)
AmazonConnectCreates a contact flow module for the specified Amazon Connect instance.
createContactFlowModule in interface AmazonConnectpublic CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperation in interface AmazonConnectpublic CreateInstanceResult createInstance(CreateInstanceRequest request)
AmazonConnectThis 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 AmazonConnectpublic CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest request)
AmazonConnectCreates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociation in interface AmazonConnectpublic CreateQueueResult createQueue(CreateQueueRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
createQueue in interface AmazonConnectpublic CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest request)
AmazonConnectCreates a quick connect for the specified Amazon Connect instance.
createQuickConnect in interface AmazonConnectpublic CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
AmazonConnectCreates a new routing profile.
createRoutingProfile in interface AmazonConnectpublic CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Creates a security profile.
createSecurityProfile in interface AmazonConnectpublic CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest request)
AmazonConnectCreates a new task template in the specified Amazon Connect instance.
createTaskTemplate in interface AmazonConnectpublic CreateUseCaseResult createUseCase(CreateUseCaseRequest request)
AmazonConnectCreates a use case for an integration association.
createUseCase in interface AmazonConnectpublic CreateUserResult createUser(CreateUserRequest request)
AmazonConnectCreates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
createUser in interface AmazonConnectpublic CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
AmazonConnectCreates a new user hierarchy group.
createUserHierarchyGroup in interface AmazonConnectpublic CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)
AmazonConnectCreates 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 AmazonConnectpublic DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest request)
AmazonConnectDeletes a contact flow for the specified Amazon Connect instance.
deleteContactFlow in interface AmazonConnectpublic DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest request)
AmazonConnectDeletes the specified contact flow module.
deleteContactFlowModule in interface AmazonConnectpublic DeleteHoursOfOperationResult deleteHoursOfOperation(DeleteHoursOfOperationRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperation in interface AmazonConnectpublic DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonConnectThis 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 AmazonConnectpublic DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
AmazonConnectDeletes 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 AmazonConnectpublic DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest request)
AmazonConnectDeletes a quick connect.
deleteQuickConnect in interface AmazonConnectpublic DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Deletes a security profile.
deleteSecurityProfile in interface AmazonConnectpublic DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest request)
AmazonConnectDeletes the task template.
deleteTaskTemplate in interface AmazonConnectpublic DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest request)
AmazonConnectDeletes a use case from an integration association.
deleteUseCase in interface AmazonConnectpublic DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonConnectDeletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
deleteUser in interface AmazonConnectpublic DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
AmazonConnectDeletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroup in interface AmazonConnectpublic DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)
AmazonConnectDeletes the vocabulary that has the given identifier.
deleteVocabulary in interface AmazonConnectpublic DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatus in interface AmazonConnectpublic DescribeContactResult describeContact(DescribeContactRequest request)
AmazonConnectThis 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.
describeContact in interface AmazonConnectpublic DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
AmazonConnectDescribes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
describeContactFlow in interface AmazonConnectpublic DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest request)
AmazonConnectDescribes the specified contact flow module.
describeContactFlowModule in interface AmazonConnectpublic DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperation in interface AmazonConnectpublic DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
AmazonConnectThis 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 AmazonConnectpublic DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttribute in interface AmazonConnectpublic DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
AmazonConnectThis 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 AmazonConnectpublic DescribePhoneNumberResult describePhoneNumber(DescribePhoneNumberRequest request)
AmazonConnectGets details and status of a phone number that’s claimed to your Amazon Connect instance
describePhoneNumber in interface AmazonConnectpublic DescribeQueueResult describeQueue(DescribeQueueRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueue in interface AmazonConnectpublic DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest request)
AmazonConnectDescribes the quick connect.
describeQuickConnect in interface AmazonConnectpublic DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
AmazonConnectDescribes the specified routing profile.
describeRoutingProfile in interface AmazonConnectpublic DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Gets basic information about the security profle.
describeSecurityProfile in interface AmazonConnectpublic DescribeUserResult describeUser(DescribeUserRequest request)
AmazonConnectDescribes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
describeUser in interface AmazonConnectpublic DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
AmazonConnectDescribes the specified hierarchy group.
describeUserHierarchyGroup in interface AmazonConnectpublic DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
AmazonConnectDescribes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure in interface AmazonConnectpublic DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest request)
AmazonConnectDescribes the specified vocabulary.
describeVocabulary in interface AmazonConnectpublic DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin in interface AmazonConnectpublic DisassociateBotResult disassociateBot(DisassociateBotRequest request)
AmazonConnectThis 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 AmazonConnectpublic DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
AmazonConnectThis 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 AmazonConnectpublic DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
AmazonConnectThis 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 contact flow blocks.
disassociateLambdaFunction in interface AmazonConnectpublic DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest request)
AmazonConnectThis 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 AmazonConnectpublic DisassociatePhoneNumberContactFlowResult disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest request)
AmazonConnectRemoves the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.
disassociatePhoneNumberContactFlow in interface AmazonConnectpublic DisassociateQueueQuickConnectsResult disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest request)
AmazonConnectThis 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 AmazonConnectpublic DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
AmazonConnectDisassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues in interface AmazonConnectpublic DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKey in interface AmazonConnectpublic GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
AmazonConnectRetrieves the contact attributes for the specified contact.
getContactAttributes in interface AmazonConnectpublic GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
AmazonConnectGets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricData in interface AmazonConnectpublic GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest request)
AmazonConnectGets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserData in interface AmazonConnectpublic GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
AmazonConnectRetrieves 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 AmazonConnectpublic GetMetricDataResult getMetricData(GetMetricDataRequest request)
AmazonConnectGets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
getMetricData in interface AmazonConnectpublic GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest request)
AmazonConnectGets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplate in interface AmazonConnectpublic ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatuses in interface AmazonConnectpublic ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListBotsResult listBots(ListBotsRequest request)
AmazonConnectThis 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.
listBots in interface AmazonConnectpublic ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest request)
AmazonConnectProvides information about the contact flow modules for the specified Amazon Connect instance.
listContactFlowModules in interface AmazonConnectpublic ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
AmazonConnectProvides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
listContactFlows in interface AmazonConnectpublic ListContactReferencesResult listContactReferences(ListContactReferencesRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest request)
AmazonConnectLists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabularies in interface AmazonConnectpublic ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
AmazonConnectProvides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperations in interface AmazonConnectpublic ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListInstancesResult listInstances(ListInstancesRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest request)
AmazonConnectProvides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociations in interface AmazonConnectpublic ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest request)
AmazonConnectThis 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 contact flow blocks.
listLambdaFunctions in interface AmazonConnectpublic ListLexBotsResult listLexBots(ListLexBotsRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
listLexBots in interface AmazonConnectpublic ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonConnectProvides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
listPhoneNumbers in interface AmazonConnectpublic ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request request)
AmazonConnectLists phone numbers claimed to your Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
listPhoneNumbersV2 in interface AmazonConnectpublic ListPromptsResult listPrompts(ListPromptsRequest request)
AmazonConnectProvides information about the prompts for the specified Amazon Connect instance.
listPrompts in interface AmazonConnectpublic ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnects in interface AmazonConnectpublic ListQueuesResult listQueues(ListQueuesRequest request)
AmazonConnectProvides 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 AmazonConnectpublic ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest request)
AmazonConnectProvides information about the quick connects for the specified Amazon Connect instance.
listQuickConnects in interface AmazonConnectpublic ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
AmazonConnectLists the queues associated with a routing profile.
listRoutingProfileQueues in interface AmazonConnectpublic ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
AmazonConnectProvides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfiles in interface AmazonConnectpublic ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest request)
AmazonConnectThis 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 AmazonConnectpublic ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Lists the permissions granted to a security profile.
listSecurityProfilePermissions in interface AmazonConnectpublic ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AmazonConnectProvides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfiles in interface AmazonConnectpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonConnectLists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResource in interface AmazonConnectpublic ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest request)
AmazonConnectLists task templates for the specified Amazon Connect instance.
listTaskTemplates in interface AmazonConnectpublic ListUseCasesResult listUseCases(ListUseCasesRequest request)
AmazonConnectLists the use cases for the integration association.
listUseCases in interface AmazonConnectrequest - Provides summary information about the use cases for the specified integration association.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
AmazonConnectProvides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroups in interface AmazonConnectpublic ListUsersResult listUsers(ListUsersRequest request)
AmazonConnectProvides summary information about the users for the specified Amazon Connect instance.
listUsers in interface AmazonConnectpublic PutUserStatusResult putUserStatus(PutUserStatusRequest request)
AmazonConnectChanges 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 AmazonConnectpublic ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest request)
AmazonConnectReleases a phone number previously claimed to an Amazon Connect instance.
releasePhoneNumber in interface AmazonConnectpublic ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
AmazonConnectWhen a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
resumeContactRecording in interface AmazonConnectpublic SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
AmazonConnectSearches for available phone numbers that you can claim to your Amazon Connect instance.
searchAvailablePhoneNumbers in interface AmazonConnectpublic SearchUsersResult searchUsers(SearchUsersRequest request)
AmazonConnectSearches users in an Amazon Connect instance, with optional filtering.
searchUsers in interface AmazonConnectpublic SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest request)
AmazonConnect
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabularies in interface AmazonConnectpublic StartChatContactResult startChatContact(StartChatContactRequest request)
AmazonConnectInitiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients 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 AmazonConnectpublic StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
AmazonConnectStarts 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 AmazonConnectpublic StartContactStreamingResult startContactStreaming(StartContactStreamingRequest request)
AmazonConnectInitiates 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 AmazonConnectpublic StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
AmazonConnect
Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact
flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact 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. For more information, see Amazon Connect
Service Quotas in the Amazon Connect Administrator Guide.
startOutboundVoiceContact in interface AmazonConnectpublic StartTaskContactResult startTaskContact(StartTaskContactRequest request)
AmazonConnectInitiates a contact flow to start a new task.
startTaskContact in interface AmazonConnectpublic StopContactResult stopContact(StopContactRequest request)
AmazonConnectEnds the specified contact. This call does not work for the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
stopContact in interface AmazonConnectpublic StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
AmazonConnectStops 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 AmazonConnectpublic StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest request)
AmazonConnectEnds message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreaming in interface AmazonConnectpublic SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
AmazonConnectWhen a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
suspendContactRecording in interface AmazonConnectpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonConnectAdds the specified tags to the specified resource.
The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, hours of operation, phone number, security profiles, and task templates.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResource in interface AmazonConnectpublic TransferContactResult transferContact(TransferContactRequest request)
AmazonConnectTransfers 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 contact 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 contact flow types are supported: Inbound contact 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 AmazonConnectpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonConnectRemoves the specified tags from the specified resource.
untagResource in interface AmazonConnectpublic UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatus in interface AmazonConnectpublic UpdateContactResult updateContact(UpdateContactRequest request)
AmazonConnectThis 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 AmazonConnectpublic UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
AmazonConnectCreates 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 CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
updateContactAttributes in interface AmazonConnectpublic UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
AmazonConnectUpdates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContent in interface AmazonConnectpublic UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
AmazonConnectUpdates metadata about specified contact flow.
updateContactFlowMetadata in interface AmazonConnectpublic UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
AmazonConnectUpdates specified contact flow module for the specified Amazon Connect instance.
updateContactFlowModuleContent in interface AmazonConnectpublic UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
AmazonConnectUpdates metadata about specified contact flow module.
updateContactFlowModuleMetadata in interface AmazonConnectpublic UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
AmazonConnectThe name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowName in interface AmazonConnectpublic UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest request)
AmazonConnectUpdates the scheduled time of a task contact that is already scheduled.
updateContactSchedule in interface AmazonConnectpublic UpdateHoursOfOperationResult updateHoursOfOperation(UpdateHoursOfOperationRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperation in interface AmazonConnectpublic UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttribute in interface AmazonConnectpublic UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
AmazonConnectThis 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 AmazonConnectpublic UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
AmazonConnectUpdates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.
updatePhoneNumber in interface AmazonConnectpublic UpdateQueueHoursOfOperationResult updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest request)
AmazonConnectThis 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 AmazonConnectpublic UpdateQueueMaxContactsResult updateQueueMaxContacts(UpdateQueueMaxContactsRequest request)
AmazonConnectThis 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 AmazonConnectpublic UpdateQueueNameResult updateQueueName(UpdateQueueNameRequest request)
AmazonConnectThis 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 AmazonConnectpublic UpdateQueueOutboundCallerConfigResult updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest request)
AmazonConnectThis 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.
updateQueueOutboundCallerConfig in interface AmazonConnectpublic UpdateQueueStatusResult updateQueueStatus(UpdateQueueStatusRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatus in interface AmazonConnectpublic UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
AmazonConnectUpdates the configuration settings for the specified quick connect.
updateQuickConnectConfig in interface AmazonConnectpublic UpdateQuickConnectNameResult updateQuickConnectName(UpdateQuickConnectNameRequest request)
AmazonConnect
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 AmazonConnectpublic UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
AmazonConnectUpdates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency in interface AmazonConnectpublic UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
AmazonConnectUpdates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue in interface AmazonConnectpublic UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
AmazonConnect
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At
least Name or Description must be provided.
updateRoutingProfileName in interface AmazonConnectpublic UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
AmazonConnectUpdates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues in interface AmazonConnectpublic UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
AmazonConnectThis API is in preview release for Amazon Connect and is subject to change.
Updates a security profile.
updateSecurityProfile in interface AmazonConnectpublic UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest request)
AmazonConnectUpdates 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 AmazonConnectpublic UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
AmazonConnectAssigns the specified hierarchy group to the specified user.
updateUserHierarchy in interface AmazonConnectpublic UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
AmazonConnectUpdates the name of the user hierarchy group.
updateUserHierarchyGroupName in interface AmazonConnectpublic UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
AmazonConnectUpdates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure in interface AmazonConnectpublic UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
AmazonConnectUpdates 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 AmazonConnectpublic UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
AmazonConnectUpdates the phone configuration settings for the specified user.
updateUserPhoneConfig in interface AmazonConnectpublic UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
AmazonConnectAssigns the specified routing profile to the specified user.
updateUserRoutingProfile in interface AmazonConnectpublic UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
AmazonConnectAssigns the specified security profiles to the specified user.
updateUserSecurityProfiles in interface AmazonConnectpublic void shutdown()
AmazonConnectshutdown in interface AmazonConnectpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnectResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonConnectrequest - The originally executed request.