@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectAsyncClient extends AmazonConnectClient implements AmazonConnectAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXactivateEvaluationForm, associateAnalyticsDataSet, associateApprovedOrigin, associateBot, associateDefaultVocabulary, associateFlow, associateInstanceStorageConfig, associateLambdaFunction, associateLexBot, associatePhoneNumberContactFlow, associateQueueQuickConnects, associateRoutingProfileQueues, associateSecurityKey, associateTrafficDistributionGroupUser, associateUserProficiencies, batchAssociateAnalyticsDataSet, batchDisassociateAnalyticsDataSet, batchGetAttachedFileMetadata, batchGetFlowAssociation, batchPutContact, builder, claimPhoneNumber, completeAttachedFileUpload, createAgentStatus, createContactFlow, createContactFlowModule, createEvaluationForm, createHoursOfOperation, createInstance, createIntegrationAssociation, createParticipant, createPersistentContactAssociation, createPredefinedAttribute, createPrompt, createQueue, createQuickConnect, createRoutingProfile, createRule, createSecurityProfile, createTaskTemplate, createTrafficDistributionGroup, createUseCase, createUser, createUserHierarchyGroup, createView, createViewVersion, createVocabulary, deactivateEvaluationForm, deleteAttachedFile, deleteContactEvaluation, deleteContactFlow, deleteContactFlowModule, deleteEvaluationForm, deleteHoursOfOperation, deleteInstance, deleteIntegrationAssociation, deletePredefinedAttribute, deletePrompt, deleteQueue, deleteQuickConnect, deleteRoutingProfile, deleteRule, deleteSecurityProfile, deleteTaskTemplate, deleteTrafficDistributionGroup, deleteUseCase, deleteUser, deleteUserHierarchyGroup, deleteView, deleteViewVersion, deleteVocabulary, describeAgentStatus, describeAuthenticationProfile, describeContact, describeContactEvaluation, describeContactFlow, describeContactFlowModule, describeEvaluationForm, describeHoursOfOperation, describeInstance, describeInstanceAttribute, describeInstanceStorageConfig, describePhoneNumber, describePredefinedAttribute, describePrompt, describeQueue, describeQuickConnect, describeRoutingProfile, describeRule, describeSecurityProfile, describeTrafficDistributionGroup, describeUser, describeUserHierarchyGroup, describeUserHierarchyStructure, describeView, describeVocabulary, disassociateAnalyticsDataSet, disassociateApprovedOrigin, disassociateBot, disassociateFlow, disassociateInstanceStorageConfig, disassociateLambdaFunction, disassociateLexBot, disassociatePhoneNumberContactFlow, disassociateQueueQuickConnects, disassociateRoutingProfileQueues, disassociateSecurityKey, disassociateTrafficDistributionGroupUser, disassociateUserProficiencies, dismissUserContact, getAttachedFile, getCachedResponseMetadata, getContactAttributes, getCurrentMetricData, getCurrentUserData, getFederationToken, getFlowAssociation, getMetricData, getMetricDataV2, getPromptFile, getTaskTemplate, getTrafficDistribution, importPhoneNumber, listAgentStatuses, listAnalyticsDataAssociations, listApprovedOrigins, listAuthenticationProfiles, listBots, listContactEvaluations, listContactFlowModules, listContactFlows, listContactReferences, listDefaultVocabularies, listEvaluationForms, listEvaluationFormVersions, listFlowAssociations, listHoursOfOperations, listInstanceAttributes, listInstances, listInstanceStorageConfigs, listIntegrationAssociations, listLambdaFunctions, listLexBots, listPhoneNumbers, listPhoneNumbersV2, listPredefinedAttributes, listPrompts, listQueueQuickConnects, listQueues, listQuickConnects, listRealtimeContactAnalysisSegmentsV2, listRoutingProfileQueues, listRoutingProfiles, listRules, listSecurityKeys, listSecurityProfileApplications, listSecurityProfilePermissions, listSecurityProfiles, listTagsForResource, listTaskTemplates, listTrafficDistributionGroups, listTrafficDistributionGroupUsers, listUseCases, listUserHierarchyGroups, listUserProficiencies, listUsers, listViews, listViewVersions, monitorContact, pauseContact, putUserStatus, releasePhoneNumber, replicateInstance, resumeContact, resumeContactRecording, searchAgentStatuses, searchAvailablePhoneNumbers, searchContactFlowModules, searchContactFlows, searchContacts, searchHoursOfOperations, searchPredefinedAttributes, searchPrompts, searchQueues, searchQuickConnects, searchResourceTags, searchRoutingProfiles, searchSecurityProfiles, searchUserHierarchyGroups, searchUsers, searchVocabularies, sendChatIntegrationEvent, startAttachedFileUpload, startChatContact, startContactEvaluation, startContactRecording, startContactStreaming, startOutboundVoiceContact, startTaskContact, startWebRTCContact, stopContact, stopContactRecording, stopContactStreaming, submitContactEvaluation, suspendContactRecording, tagContact, tagResource, transferContact, untagContact, untagResource, updateAgentStatus, updateAuthenticationProfile, updateContact, updateContactAttributes, updateContactEvaluation, updateContactFlowContent, updateContactFlowMetadata, updateContactFlowModuleContent, updateContactFlowModuleMetadata, updateContactFlowName, updateContactRoutingData, updateContactSchedule, updateEvaluationForm, updateHoursOfOperation, updateInstanceAttribute, updateInstanceStorageConfig, updateParticipantRoleConfig, updatePhoneNumber, updatePhoneNumberMetadata, updatePredefinedAttribute, updatePrompt, updateQueueHoursOfOperation, updateQueueMaxContacts, updateQueueName, updateQueueOutboundCallerConfig, updateQueueStatus, updateQuickConnectConfig, updateQuickConnectName, updateRoutingProfileAgentAvailabilityTimer, updateRoutingProfileConcurrency, updateRoutingProfileDefaultOutboundQueue, updateRoutingProfileName, updateRoutingProfileQueues, updateRule, updateSecurityProfile, updateTaskTemplate, updateTrafficDistribution, updateUserHierarchy, updateUserHierarchyGroupName, updateUserHierarchyStructure, updateUserIdentityInfo, updateUserPhoneConfig, updateUserProficiencies, updateUserRoutingProfile, updateUserSecurityProfiles, updateViewContent, updateViewMetadataaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitactivateEvaluationForm, associateAnalyticsDataSet, associateApprovedOrigin, associateBot, associateDefaultVocabulary, associateFlow, associateInstanceStorageConfig, associateLambdaFunction, associateLexBot, associatePhoneNumberContactFlow, associateQueueQuickConnects, associateRoutingProfileQueues, associateSecurityKey, associateTrafficDistributionGroupUser, associateUserProficiencies, batchAssociateAnalyticsDataSet, batchDisassociateAnalyticsDataSet, batchGetAttachedFileMetadata, batchGetFlowAssociation, batchPutContact, claimPhoneNumber, completeAttachedFileUpload, createAgentStatus, createContactFlow, createContactFlowModule, createEvaluationForm, createHoursOfOperation, createInstance, createIntegrationAssociation, createParticipant, createPersistentContactAssociation, createPredefinedAttribute, createPrompt, createQueue, createQuickConnect, createRoutingProfile, createRule, createSecurityProfile, createTaskTemplate, createTrafficDistributionGroup, createUseCase, createUser, createUserHierarchyGroup, createView, createViewVersion, createVocabulary, deactivateEvaluationForm, deleteAttachedFile, deleteContactEvaluation, deleteContactFlow, deleteContactFlowModule, deleteEvaluationForm, deleteHoursOfOperation, deleteInstance, deleteIntegrationAssociation, deletePredefinedAttribute, deletePrompt, deleteQueue, deleteQuickConnect, deleteRoutingProfile, deleteRule, deleteSecurityProfile, deleteTaskTemplate, deleteTrafficDistributionGroup, deleteUseCase, deleteUser, deleteUserHierarchyGroup, deleteView, deleteViewVersion, deleteVocabulary, describeAgentStatus, describeAuthenticationProfile, describeContact, describeContactEvaluation, describeContactFlow, describeContactFlowModule, describeEvaluationForm, describeHoursOfOperation, describeInstance, describeInstanceAttribute, describeInstanceStorageConfig, describePhoneNumber, describePredefinedAttribute, describePrompt, describeQueue, describeQuickConnect, describeRoutingProfile, describeRule, describeSecurityProfile, describeTrafficDistributionGroup, describeUser, describeUserHierarchyGroup, describeUserHierarchyStructure, describeView, describeVocabulary, disassociateAnalyticsDataSet, disassociateApprovedOrigin, disassociateBot, disassociateFlow, disassociateInstanceStorageConfig, disassociateLambdaFunction, disassociateLexBot, disassociatePhoneNumberContactFlow, disassociateQueueQuickConnects, disassociateRoutingProfileQueues, disassociateSecurityKey, disassociateTrafficDistributionGroupUser, disassociateUserProficiencies, dismissUserContact, getAttachedFile, getCachedResponseMetadata, getContactAttributes, getCurrentMetricData, getCurrentUserData, getFederationToken, getFlowAssociation, getMetricData, getMetricDataV2, getPromptFile, getTaskTemplate, getTrafficDistribution, importPhoneNumber, listAgentStatuses, listAnalyticsDataAssociations, listApprovedOrigins, listAuthenticationProfiles, listBots, listContactEvaluations, listContactFlowModules, listContactFlows, listContactReferences, listDefaultVocabularies, listEvaluationForms, listEvaluationFormVersions, listFlowAssociations, listHoursOfOperations, listInstanceAttributes, listInstances, listInstanceStorageConfigs, listIntegrationAssociations, listLambdaFunctions, listLexBots, listPhoneNumbers, listPhoneNumbersV2, listPredefinedAttributes, listPrompts, listQueueQuickConnects, listQueues, listQuickConnects, listRealtimeContactAnalysisSegmentsV2, listRoutingProfileQueues, listRoutingProfiles, listRules, listSecurityKeys, listSecurityProfileApplications, listSecurityProfilePermissions, listSecurityProfiles, listTagsForResource, listTaskTemplates, listTrafficDistributionGroups, listTrafficDistributionGroupUsers, listUseCases, listUserHierarchyGroups, listUserProficiencies, listUsers, listViews, listViewVersions, monitorContact, pauseContact, putUserStatus, releasePhoneNumber, replicateInstance, resumeContact, resumeContactRecording, searchAgentStatuses, searchAvailablePhoneNumbers, searchContactFlowModules, searchContactFlows, searchContacts, searchHoursOfOperations, searchPredefinedAttributes, searchPrompts, searchQueues, searchQuickConnects, searchResourceTags, searchRoutingProfiles, searchSecurityProfiles, searchUserHierarchyGroups, searchUsers, searchVocabularies, sendChatIntegrationEvent, startAttachedFileUpload, startChatContact, startContactEvaluation, startContactRecording, startContactStreaming, startOutboundVoiceContact, startTaskContact, startWebRTCContact, stopContact, stopContactRecording, stopContactStreaming, submitContactEvaluation, suspendContactRecording, tagContact, tagResource, transferContact, untagContact, untagResource, updateAgentStatus, updateAuthenticationProfile, updateContact, updateContactAttributes, updateContactEvaluation, updateContactFlowContent, updateContactFlowMetadata, updateContactFlowModuleContent, updateContactFlowModuleMetadata, updateContactFlowName, updateContactRoutingData, updateContactSchedule, updateEvaluationForm, updateHoursOfOperation, updateInstanceAttribute, updateInstanceStorageConfig, updateParticipantRoleConfig, updatePhoneNumber, updatePhoneNumberMetadata, updatePredefinedAttribute, updatePrompt, updateQueueHoursOfOperation, updateQueueMaxContacts, updateQueueName, updateQueueOutboundCallerConfig, updateQueueStatus, updateQuickConnectConfig, updateQuickConnectName, updateRoutingProfileAgentAvailabilityTimer, updateRoutingProfileConcurrency, updateRoutingProfileDefaultOutboundQueue, updateRoutingProfileName, updateRoutingProfileQueues, updateRule, updateSecurityProfile, updateTaskTemplate, updateTrafficDistribution, updateUserHierarchy, updateUserHierarchyGroupName, updateUserHierarchyStructure, updateUserIdentityInfo, updateUserPhoneConfig, updateUserProficiencies, updateUserRoutingProfile, updateUserSecurityProfiles, updateViewContent, updateViewMetadatapublic static AmazonConnectAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<ActivateEvaluationFormResult> activateEvaluationFormAsync(ActivateEvaluationFormRequest request)
AmazonConnectAsyncActivates 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.
activateEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<ActivateEvaluationFormResult> activateEvaluationFormAsync(ActivateEvaluationFormRequest request, AsyncHandler<ActivateEvaluationFormRequest,ActivateEvaluationFormResult> asyncHandler)
AmazonConnectAsyncActivates 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.
activateEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateAnalyticsDataSetResult> associateAnalyticsDataSetAsync(AssociateAnalyticsDataSetRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
associateAnalyticsDataSetAsync in interface AmazonConnectAsyncpublic Future<AssociateAnalyticsDataSetResult> associateAnalyticsDataSetAsync(AssociateAnalyticsDataSetRequest request, AsyncHandler<AssociateAnalyticsDataSetRequest,AssociateAnalyticsDataSetResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
associateAnalyticsDataSetAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateApprovedOriginResult> associateApprovedOriginAsync(AssociateApprovedOriginRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginAsync in interface AmazonConnectAsyncpublic Future<AssociateApprovedOriginResult> associateApprovedOriginAsync(AssociateApprovedOriginRequest request, AsyncHandler<AssociateApprovedOriginRequest,AssociateApprovedOriginResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateBotResult> associateBotAsync(AssociateBotRequest request)
AmazonConnectAsyncThis 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.
associateBotAsync in interface AmazonConnectAsyncpublic Future<AssociateBotResult> associateBotAsync(AssociateBotRequest request, AsyncHandler<AssociateBotRequest,AssociateBotResult> asyncHandler)
AmazonConnectAsyncThis 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.
associateBotAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateDefaultVocabularyResult> associateDefaultVocabularyAsync(AssociateDefaultVocabularyRequest request)
AmazonConnectAsyncAssociates 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.
associateDefaultVocabularyAsync in interface AmazonConnectAsyncpublic Future<AssociateDefaultVocabularyResult> associateDefaultVocabularyAsync(AssociateDefaultVocabularyRequest request, AsyncHandler<AssociateDefaultVocabularyRequest,AssociateDefaultVocabularyResult> asyncHandler)
AmazonConnectAsyncAssociates 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.
associateDefaultVocabularyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateFlowResult> associateFlowAsync(AssociateFlowRequest request)
AmazonConnectAsyncAssociates a connect resource to a flow.
associateFlowAsync in interface AmazonConnectAsyncpublic Future<AssociateFlowResult> associateFlowAsync(AssociateFlowRequest request, AsyncHandler<AssociateFlowRequest,AssociateFlowResult> asyncHandler)
AmazonConnectAsyncAssociates a connect resource to a flow.
associateFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateInstanceStorageConfigResult> associateInstanceStorageConfigAsync(AssociateInstanceStorageConfigRequest request)
AmazonConnectAsyncThis 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.
associateInstanceStorageConfigAsync in interface AmazonConnectAsyncpublic Future<AssociateInstanceStorageConfigResult> associateInstanceStorageConfigAsync(AssociateInstanceStorageConfigRequest request, AsyncHandler<AssociateInstanceStorageConfigRequest,AssociateInstanceStorageConfigResult> asyncHandler)
AmazonConnectAsyncThis 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.
associateInstanceStorageConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateLambdaFunctionResult> associateLambdaFunctionAsync(AssociateLambdaFunctionRequest request)
AmazonConnectAsyncThis 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.
associateLambdaFunctionAsync in interface AmazonConnectAsyncpublic Future<AssociateLambdaFunctionResult> associateLambdaFunctionAsync(AssociateLambdaFunctionRequest request, AsyncHandler<AssociateLambdaFunctionRequest,AssociateLambdaFunctionResult> asyncHandler)
AmazonConnectAsyncThis 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.
associateLambdaFunctionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateLexBotResult> associateLexBotAsync(AssociateLexBotRequest request)
AmazonConnectAsyncThis 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.
associateLexBotAsync in interface AmazonConnectAsyncpublic Future<AssociateLexBotResult> associateLexBotAsync(AssociateLexBotRequest request, AsyncHandler<AssociateLexBotRequest,AssociateLexBotResult> asyncHandler)
AmazonConnectAsyncThis 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.
associateLexBotAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociatePhoneNumberContactFlowResult> associatePhoneNumberContactFlowAsync(AssociatePhoneNumberContactFlowRequest request)
AmazonConnectAsyncAssociates 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.
associatePhoneNumberContactFlowAsync in interface AmazonConnectAsyncpublic Future<AssociatePhoneNumberContactFlowResult> associatePhoneNumberContactFlowAsync(AssociatePhoneNumberContactFlowRequest request, AsyncHandler<AssociatePhoneNumberContactFlowRequest,AssociatePhoneNumberContactFlowResult> asyncHandler)
AmazonConnectAsyncAssociates 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.
associatePhoneNumberContactFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateQueueQuickConnectsResult> associateQueueQuickConnectsAsync(AssociateQueueQuickConnectsRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsAsync in interface AmazonConnectAsyncpublic Future<AssociateQueueQuickConnectsResult> associateQueueQuickConnectsAsync(AssociateQueueQuickConnectsRequest request, AsyncHandler<AssociateQueueQuickConnectsRequest,AssociateQueueQuickConnectsResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateRoutingProfileQueuesResult> associateRoutingProfileQueuesAsync(AssociateRoutingProfileQueuesRequest request)
AmazonConnectAsyncAssociates a set of queues with a routing profile.
associateRoutingProfileQueuesAsync in interface AmazonConnectAsyncpublic Future<AssociateRoutingProfileQueuesResult> associateRoutingProfileQueuesAsync(AssociateRoutingProfileQueuesRequest request, AsyncHandler<AssociateRoutingProfileQueuesRequest,AssociateRoutingProfileQueuesResult> asyncHandler)
AmazonConnectAsyncAssociates a set of queues with a routing profile.
associateRoutingProfileQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateSecurityKeyResult> associateSecurityKeyAsync(AssociateSecurityKeyRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyAsync in interface AmazonConnectAsyncpublic Future<AssociateSecurityKeyResult> associateSecurityKeyAsync(AssociateSecurityKeyRequest request, AsyncHandler<AssociateSecurityKeyRequest,AssociateSecurityKeyResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateTrafficDistributionGroupUserResult> associateTrafficDistributionGroupUserAsync(AssociateTrafficDistributionGroupUserRequest request)
AmazonConnectAsyncAssociates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserAsync in interface AmazonConnectAsyncpublic Future<AssociateTrafficDistributionGroupUserResult> associateTrafficDistributionGroupUserAsync(AssociateTrafficDistributionGroupUserRequest request, AsyncHandler<AssociateTrafficDistributionGroupUserRequest,AssociateTrafficDistributionGroupUserResult> asyncHandler)
AmazonConnectAsyncAssociates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateUserProficienciesResult> associateUserProficienciesAsync(AssociateUserProficienciesRequest request)
AmazonConnectAsync>Associates a set of proficiencies with a user.
associateUserProficienciesAsync in interface AmazonConnectAsyncpublic Future<AssociateUserProficienciesResult> associateUserProficienciesAsync(AssociateUserProficienciesRequest request, AsyncHandler<AssociateUserProficienciesRequest,AssociateUserProficienciesResult> asyncHandler)
AmazonConnectAsync>Associates a set of proficiencies with a user.
associateUserProficienciesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchAssociateAnalyticsDataSetResult> batchAssociateAnalyticsDataSetAsync(BatchAssociateAnalyticsDataSetRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
batchAssociateAnalyticsDataSetAsync in interface AmazonConnectAsyncpublic Future<BatchAssociateAnalyticsDataSetResult> batchAssociateAnalyticsDataSetAsync(BatchAssociateAnalyticsDataSetRequest request, AsyncHandler<BatchAssociateAnalyticsDataSetRequest,BatchAssociateAnalyticsDataSetResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
batchAssociateAnalyticsDataSetAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchDisassociateAnalyticsDataSetResult> batchDisassociateAnalyticsDataSetAsync(BatchDisassociateAnalyticsDataSetRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
batchDisassociateAnalyticsDataSetAsync in interface AmazonConnectAsyncpublic Future<BatchDisassociateAnalyticsDataSetResult> batchDisassociateAnalyticsDataSetAsync(BatchDisassociateAnalyticsDataSetRequest request, AsyncHandler<BatchDisassociateAnalyticsDataSetRequest,BatchDisassociateAnalyticsDataSetResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
batchDisassociateAnalyticsDataSetAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchGetAttachedFileMetadataResult> batchGetAttachedFileMetadataAsync(BatchGetAttachedFileMetadataRequest request)
AmazonConnectAsyncAllows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
batchGetAttachedFileMetadataAsync in interface AmazonConnectAsyncpublic Future<BatchGetAttachedFileMetadataResult> batchGetAttachedFileMetadataAsync(BatchGetAttachedFileMetadataRequest request, AsyncHandler<BatchGetAttachedFileMetadataRequest,BatchGetAttachedFileMetadataResult> asyncHandler)
AmazonConnectAsyncAllows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
batchGetAttachedFileMetadataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchGetFlowAssociationResult> batchGetFlowAssociationAsync(BatchGetFlowAssociationRequest request)
AmazonConnectAsyncRetrieve the flow associations for the given resources.
batchGetFlowAssociationAsync in interface AmazonConnectAsyncpublic Future<BatchGetFlowAssociationResult> batchGetFlowAssociationAsync(BatchGetFlowAssociationRequest request, AsyncHandler<BatchGetFlowAssociationRequest,BatchGetFlowAssociationResult> asyncHandler)
AmazonConnectAsyncRetrieve the flow associations for the given resources.
batchGetFlowAssociationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchPutContactResult> batchPutContactAsync(BatchPutContactRequest request)
AmazonConnectAsyncOnly the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
batchPutContactAsync in interface AmazonConnectAsyncpublic Future<BatchPutContactResult> batchPutContactAsync(BatchPutContactRequest request, AsyncHandler<BatchPutContactRequest,BatchPutContactResult> asyncHandler)
AmazonConnectAsyncOnly the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
batchPutContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ClaimPhoneNumberResult> claimPhoneNumberAsync(ClaimPhoneNumberRequest request)
AmazonConnectAsyncClaims 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.
claimPhoneNumberAsync in interface AmazonConnectAsyncpublic Future<ClaimPhoneNumberResult> claimPhoneNumberAsync(ClaimPhoneNumberRequest request, AsyncHandler<ClaimPhoneNumberRequest,ClaimPhoneNumberResult> asyncHandler)
AmazonConnectAsyncClaims 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.
claimPhoneNumberAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CompleteAttachedFileUploadResult> completeAttachedFileUploadAsync(CompleteAttachedFileUploadRequest request)
AmazonConnectAsyncAllows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUploadAsync in interface AmazonConnectAsyncrequest - Request to CompleteAttachedFileUpload APIpublic Future<CompleteAttachedFileUploadResult> completeAttachedFileUploadAsync(CompleteAttachedFileUploadRequest request, AsyncHandler<CompleteAttachedFileUploadRequest,CompleteAttachedFileUploadResult> asyncHandler)
AmazonConnectAsyncAllows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUploadAsync in interface AmazonConnectAsyncrequest - Request to CompleteAttachedFileUpload APIasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAgentStatusResult> createAgentStatusAsync(CreateAgentStatusRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusAsync in interface AmazonConnectAsyncpublic Future<CreateAgentStatusResult> createAgentStatusAsync(CreateAgentStatusRequest request, AsyncHandler<CreateAgentStatusRequest,CreateAgentStatusResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateContactFlowResult> createContactFlowAsync(CreateContactFlowRequest request)
AmazonConnectAsyncCreates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowAsync in interface AmazonConnectAsyncpublic Future<CreateContactFlowResult> createContactFlowAsync(CreateContactFlowRequest request, AsyncHandler<CreateContactFlowRequest,CreateContactFlowResult> asyncHandler)
AmazonConnectAsyncCreates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateContactFlowModuleResult> createContactFlowModuleAsync(CreateContactFlowModuleRequest request)
AmazonConnectAsyncCreates a flow module for the specified Amazon Connect instance.
createContactFlowModuleAsync in interface AmazonConnectAsyncpublic Future<CreateContactFlowModuleResult> createContactFlowModuleAsync(CreateContactFlowModuleRequest request, AsyncHandler<CreateContactFlowModuleRequest,CreateContactFlowModuleResult> asyncHandler)
AmazonConnectAsyncCreates a flow module for the specified Amazon Connect instance.
createContactFlowModuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateEvaluationFormResult> createEvaluationFormAsync(CreateEvaluationFormRequest request)
AmazonConnectAsyncCreates 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.
createEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<CreateEvaluationFormResult> createEvaluationFormAsync(CreateEvaluationFormRequest request, AsyncHandler<CreateEvaluationFormRequest,CreateEvaluationFormResult> asyncHandler)
AmazonConnectAsyncCreates 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.
createEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateHoursOfOperationResult> createHoursOfOperationAsync(CreateHoursOfOperationRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationAsync in interface AmazonConnectAsyncpublic Future<CreateHoursOfOperationResult> createHoursOfOperationAsync(CreateHoursOfOperationRequest request, AsyncHandler<CreateHoursOfOperationRequest,CreateHoursOfOperationResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateInstanceResult> createInstanceAsync(CreateInstanceRequest request)
AmazonConnectAsyncThis 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.
createInstanceAsync in interface AmazonConnectAsyncpublic Future<CreateInstanceResult> createInstanceAsync(CreateInstanceRequest request, AsyncHandler<CreateInstanceRequest,CreateInstanceResult> asyncHandler)
AmazonConnectAsyncThis 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.
createInstanceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIntegrationAssociationResult> createIntegrationAssociationAsync(CreateIntegrationAssociationRequest request)
AmazonConnectAsyncCreates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationAsync in interface AmazonConnectAsyncpublic Future<CreateIntegrationAssociationResult> createIntegrationAssociationAsync(CreateIntegrationAssociationRequest request, AsyncHandler<CreateIntegrationAssociationRequest,CreateIntegrationAssociationResult> asyncHandler)
AmazonConnectAsyncCreates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateParticipantResult> createParticipantAsync(CreateParticipantRequest request)
AmazonConnectAsyncAdds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantAsync in interface AmazonConnectAsyncpublic Future<CreateParticipantResult> createParticipantAsync(CreateParticipantRequest request, AsyncHandler<CreateParticipantRequest,CreateParticipantResult> asyncHandler)
AmazonConnectAsyncAdds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePersistentContactAssociationResult> createPersistentContactAssociationAsync(CreatePersistentContactAssociationRequest request)
AmazonConnectAsyncEnables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
createPersistentContactAssociationAsync in interface AmazonConnectAsyncpublic Future<CreatePersistentContactAssociationResult> createPersistentContactAssociationAsync(CreatePersistentContactAssociationRequest request, AsyncHandler<CreatePersistentContactAssociationRequest,CreatePersistentContactAssociationResult> asyncHandler)
AmazonConnectAsyncEnables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
createPersistentContactAssociationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePredefinedAttributeResult> createPredefinedAttributeAsync(CreatePredefinedAttributeRequest request)
AmazonConnectAsyncCreates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttributeAsync in interface AmazonConnectAsyncpublic Future<CreatePredefinedAttributeResult> createPredefinedAttributeAsync(CreatePredefinedAttributeRequest request, AsyncHandler<CreatePredefinedAttributeRequest,CreatePredefinedAttributeResult> asyncHandler)
AmazonConnectAsyncCreates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePromptResult> createPromptAsync(CreatePromptRequest request)
AmazonConnectAsyncCreates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPromptAsync in interface AmazonConnectAsyncpublic Future<CreatePromptResult> createPromptAsync(CreatePromptRequest request, AsyncHandler<CreatePromptRequest,CreatePromptResult> asyncHandler)
AmazonConnectAsyncCreates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPromptAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest request)
AmazonConnectAsyncThis 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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is 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.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
createQueueAsync in interface AmazonConnectAsyncpublic Future<CreateQueueResult> createQueueAsync(CreateQueueRequest request, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
AmazonConnectAsyncThis 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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is 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.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
createQueueAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateQuickConnectResult> createQuickConnectAsync(CreateQuickConnectRequest request)
AmazonConnectAsyncCreates a quick connect for the specified Amazon Connect instance.
createQuickConnectAsync in interface AmazonConnectAsyncpublic Future<CreateQuickConnectResult> createQuickConnectAsync(CreateQuickConnectRequest request, AsyncHandler<CreateQuickConnectRequest,CreateQuickConnectResult> asyncHandler)
AmazonConnectAsyncCreates a quick connect for the specified Amazon Connect instance.
createQuickConnectAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRoutingProfileResult> createRoutingProfileAsync(CreateRoutingProfileRequest request)
AmazonConnectAsyncCreates a new routing profile.
createRoutingProfileAsync in interface AmazonConnectAsyncpublic Future<CreateRoutingProfileResult> createRoutingProfileAsync(CreateRoutingProfileRequest request, AsyncHandler<CreateRoutingProfileRequest,CreateRoutingProfileResult> asyncHandler)
AmazonConnectAsyncCreates a new routing profile.
createRoutingProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRuleResult> createRuleAsync(CreateRuleRequest request)
AmazonConnectAsyncCreates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleAsync in interface AmazonConnectAsyncpublic Future<CreateRuleResult> createRuleAsync(CreateRuleRequest request, AsyncHandler<CreateRuleRequest,CreateRuleResult> asyncHandler)
AmazonConnectAsyncCreates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest request)
AmazonConnectAsyncCreates a security profile.
createSecurityProfileAsync in interface AmazonConnectAsyncpublic Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest request, AsyncHandler<CreateSecurityProfileRequest,CreateSecurityProfileResult> asyncHandler)
AmazonConnectAsyncCreates a security profile.
createSecurityProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTaskTemplateResult> createTaskTemplateAsync(CreateTaskTemplateRequest request)
AmazonConnectAsyncCreates a new task template in the specified Amazon Connect instance.
createTaskTemplateAsync in interface AmazonConnectAsyncpublic Future<CreateTaskTemplateResult> createTaskTemplateAsync(CreateTaskTemplateRequest request, AsyncHandler<CreateTaskTemplateRequest,CreateTaskTemplateResult> asyncHandler)
AmazonConnectAsyncCreates a new task template in the specified Amazon Connect instance.
createTaskTemplateAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTrafficDistributionGroupResult> createTrafficDistributionGroupAsync(CreateTrafficDistributionGroupRequest request)
AmazonConnectAsyncCreates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified
SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
createTrafficDistributionGroupAsync in interface AmazonConnectAsyncpublic Future<CreateTrafficDistributionGroupResult> createTrafficDistributionGroupAsync(CreateTrafficDistributionGroupRequest request, AsyncHandler<CreateTrafficDistributionGroupRequest,CreateTrafficDistributionGroupResult> asyncHandler)
AmazonConnectAsyncCreates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified
SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
createTrafficDistributionGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUseCaseResult> createUseCaseAsync(CreateUseCaseRequest request)
AmazonConnectAsyncCreates a use case for an integration association.
createUseCaseAsync in interface AmazonConnectAsyncpublic Future<CreateUseCaseResult> createUseCaseAsync(CreateUseCaseRequest request, AsyncHandler<CreateUseCaseRequest,CreateUseCaseResult> asyncHandler)
AmazonConnectAsyncCreates a use case for an integration association.
createUseCaseAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AmazonConnectAsyncCreates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo
parameters are required in some situations. For example, Email is required if you are using SAML for
identity management. FirstName and LastName are required if you are using Amazon
Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
createUserAsync in interface AmazonConnectAsyncpublic Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AmazonConnectAsyncCreates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo
parameters are required in some situations. For example, Email is required if you are using SAML for
identity management. FirstName and LastName are required if you are using Amazon
Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
createUserAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserHierarchyGroupResult> createUserHierarchyGroupAsync(CreateUserHierarchyGroupRequest request)
AmazonConnectAsyncCreates a new user hierarchy group.
createUserHierarchyGroupAsync in interface AmazonConnectAsyncpublic Future<CreateUserHierarchyGroupResult> createUserHierarchyGroupAsync(CreateUserHierarchyGroupRequest request, AsyncHandler<CreateUserHierarchyGroupRequest,CreateUserHierarchyGroupResult> asyncHandler)
AmazonConnectAsyncCreates a new user hierarchy group.
createUserHierarchyGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateViewResult> createViewAsync(CreateViewRequest request)
AmazonConnectAsync
Creates a new view with the possible status of SAVED or PUBLISHED.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED or full content validation if the status
is set to PUBLISHED. An error is returned if validation fails. It associates either the
$SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the
provided view content based on the status. The view is idempotent if ClientToken is provided.
createViewAsync in interface AmazonConnectAsyncpublic Future<CreateViewResult> createViewAsync(CreateViewRequest request, AsyncHandler<CreateViewRequest,CreateViewResult> asyncHandler)
AmazonConnectAsync
Creates a new view with the possible status of SAVED or PUBLISHED.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED or full content validation if the status
is set to PUBLISHED. An error is returned if validation fails. It associates either the
$SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the
provided view content based on the status. The view is idempotent if ClientToken is provided.
createViewAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateViewVersionResult> createViewVersionAsync(CreateViewVersionRequest request)
AmazonConnectAsyncPublishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed
if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
createViewVersionAsync in interface AmazonConnectAsyncpublic Future<CreateViewVersionResult> createViewVersionAsync(CreateViewVersionRequest request, AsyncHandler<CreateViewVersionRequest,CreateViewVersionResult> asyncHandler)
AmazonConnectAsyncPublishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed
if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
createViewVersionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest request)
AmazonConnectAsyncCreates 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.
createVocabularyAsync in interface AmazonConnectAsyncpublic Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest request, AsyncHandler<CreateVocabularyRequest,CreateVocabularyResult> asyncHandler)
AmazonConnectAsyncCreates 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.
createVocabularyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeactivateEvaluationFormResult> deactivateEvaluationFormAsync(DeactivateEvaluationFormRequest request)
AmazonConnectAsyncDeactivates 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.
deactivateEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<DeactivateEvaluationFormResult> deactivateEvaluationFormAsync(DeactivateEvaluationFormRequest request, AsyncHandler<DeactivateEvaluationFormRequest,DeactivateEvaluationFormResult> asyncHandler)
AmazonConnectAsyncDeactivates 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.
deactivateEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAttachedFileResult> deleteAttachedFileAsync(DeleteAttachedFileRequest request)
AmazonConnectAsyncDeletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFileAsync in interface AmazonConnectAsyncrequest - Request to DeleteAttachedFile APIpublic Future<DeleteAttachedFileResult> deleteAttachedFileAsync(DeleteAttachedFileRequest request, AsyncHandler<DeleteAttachedFileRequest,DeleteAttachedFileResult> asyncHandler)
AmazonConnectAsyncDeletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFileAsync in interface AmazonConnectAsyncrequest - Request to DeleteAttachedFile APIasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteContactEvaluationResult> deleteContactEvaluationAsync(DeleteContactEvaluationRequest request)
AmazonConnectAsyncDeletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationAsync in interface AmazonConnectAsyncpublic Future<DeleteContactEvaluationResult> deleteContactEvaluationAsync(DeleteContactEvaluationRequest request, AsyncHandler<DeleteContactEvaluationRequest,DeleteContactEvaluationResult> asyncHandler)
AmazonConnectAsyncDeletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteContactFlowResult> deleteContactFlowAsync(DeleteContactFlowRequest request)
AmazonConnectAsyncDeletes a flow for the specified Amazon Connect instance.
deleteContactFlowAsync in interface AmazonConnectAsyncpublic Future<DeleteContactFlowResult> deleteContactFlowAsync(DeleteContactFlowRequest request, AsyncHandler<DeleteContactFlowRequest,DeleteContactFlowResult> asyncHandler)
AmazonConnectAsyncDeletes a flow for the specified Amazon Connect instance.
deleteContactFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteContactFlowModuleResult> deleteContactFlowModuleAsync(DeleteContactFlowModuleRequest request)
AmazonConnectAsyncDeletes the specified flow module.
deleteContactFlowModuleAsync in interface AmazonConnectAsyncpublic Future<DeleteContactFlowModuleResult> deleteContactFlowModuleAsync(DeleteContactFlowModuleRequest request, AsyncHandler<DeleteContactFlowModuleRequest,DeleteContactFlowModuleResult> asyncHandler)
AmazonConnectAsyncDeletes the specified flow module.
deleteContactFlowModuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEvaluationFormResult> deleteEvaluationFormAsync(DeleteEvaluationFormRequest request)
AmazonConnectAsyncDeletes 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.
deleteEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<DeleteEvaluationFormResult> deleteEvaluationFormAsync(DeleteEvaluationFormRequest request, AsyncHandler<DeleteEvaluationFormRequest,DeleteEvaluationFormResult> asyncHandler)
AmazonConnectAsyncDeletes 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.
deleteEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteHoursOfOperationResult> deleteHoursOfOperationAsync(DeleteHoursOfOperationRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationAsync in interface AmazonConnectAsyncpublic Future<DeleteHoursOfOperationResult> deleteHoursOfOperationAsync(DeleteHoursOfOperationRequest request, AsyncHandler<DeleteHoursOfOperationRequest,DeleteHoursOfOperationResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteInstanceResult> deleteInstanceAsync(DeleteInstanceRequest request)
AmazonConnectAsyncThis 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.
deleteInstanceAsync in interface AmazonConnectAsyncpublic Future<DeleteInstanceResult> deleteInstanceAsync(DeleteInstanceRequest request, AsyncHandler<DeleteInstanceRequest,DeleteInstanceResult> asyncHandler)
AmazonConnectAsyncThis 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.
deleteInstanceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteIntegrationAssociationResult> deleteIntegrationAssociationAsync(DeleteIntegrationAssociationRequest request)
AmazonConnectAsyncDeletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationAsync in interface AmazonConnectAsyncpublic Future<DeleteIntegrationAssociationResult> deleteIntegrationAssociationAsync(DeleteIntegrationAssociationRequest request, AsyncHandler<DeleteIntegrationAssociationRequest,DeleteIntegrationAssociationResult> asyncHandler)
AmazonConnectAsyncDeletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePredefinedAttributeResult> deletePredefinedAttributeAsync(DeletePredefinedAttributeRequest request)
AmazonConnectAsyncDeletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttributeAsync in interface AmazonConnectAsyncpublic Future<DeletePredefinedAttributeResult> deletePredefinedAttributeAsync(DeletePredefinedAttributeRequest request, AsyncHandler<DeletePredefinedAttributeRequest,DeletePredefinedAttributeResult> asyncHandler)
AmazonConnectAsyncDeletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePromptResult> deletePromptAsync(DeletePromptRequest request)
AmazonConnectAsyncDeletes a prompt.
deletePromptAsync in interface AmazonConnectAsyncpublic Future<DeletePromptResult> deletePromptAsync(DeletePromptRequest request, AsyncHandler<DeletePromptRequest,DeletePromptResult> asyncHandler)
AmazonConnectAsyncDeletes a prompt.
deletePromptAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest request)
AmazonConnectAsyncDeletes a queue.
deleteQueueAsync in interface AmazonConnectAsyncpublic Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest request, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
AmazonConnectAsyncDeletes a queue.
deleteQueueAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteQuickConnectResult> deleteQuickConnectAsync(DeleteQuickConnectRequest request)
AmazonConnectAsyncDeletes a quick connect.
After calling DeleteUser, it's important
to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteQuickConnectAsync in interface AmazonConnectAsyncpublic Future<DeleteQuickConnectResult> deleteQuickConnectAsync(DeleteQuickConnectRequest request, AsyncHandler<DeleteQuickConnectRequest,DeleteQuickConnectResult> asyncHandler)
AmazonConnectAsyncDeletes a quick connect.
After calling DeleteUser, it's important
to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteQuickConnectAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRoutingProfileResult> deleteRoutingProfileAsync(DeleteRoutingProfileRequest request)
AmazonConnectAsyncDeletes a routing profile.
deleteRoutingProfileAsync in interface AmazonConnectAsyncpublic Future<DeleteRoutingProfileResult> deleteRoutingProfileAsync(DeleteRoutingProfileRequest request, AsyncHandler<DeleteRoutingProfileRequest,DeleteRoutingProfileResult> asyncHandler)
AmazonConnectAsyncDeletes a routing profile.
deleteRoutingProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request)
AmazonConnectAsyncDeletes a rule for the specified Amazon Connect instance.
deleteRuleAsync in interface AmazonConnectAsyncpublic Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
AmazonConnectAsyncDeletes a rule for the specified Amazon Connect instance.
deleteRuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest request)
AmazonConnectAsyncDeletes a security profile.
deleteSecurityProfileAsync in interface AmazonConnectAsyncpublic Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest request, AsyncHandler<DeleteSecurityProfileRequest,DeleteSecurityProfileResult> asyncHandler)
AmazonConnectAsyncDeletes a security profile.
deleteSecurityProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTaskTemplateResult> deleteTaskTemplateAsync(DeleteTaskTemplateRequest request)
AmazonConnectAsyncDeletes the task template.
deleteTaskTemplateAsync in interface AmazonConnectAsyncpublic Future<DeleteTaskTemplateResult> deleteTaskTemplateAsync(DeleteTaskTemplateRequest request, AsyncHandler<DeleteTaskTemplateRequest,DeleteTaskTemplateResult> asyncHandler)
AmazonConnectAsyncDeletes the task template.
deleteTaskTemplateAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTrafficDistributionGroupResult> deleteTrafficDistributionGroupAsync(DeleteTrafficDistributionGroupRequest request)
AmazonConnectAsyncDeletes 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.
deleteTrafficDistributionGroupAsync in interface AmazonConnectAsyncpublic Future<DeleteTrafficDistributionGroupResult> deleteTrafficDistributionGroupAsync(DeleteTrafficDistributionGroupRequest request, AsyncHandler<DeleteTrafficDistributionGroupRequest,DeleteTrafficDistributionGroupResult> asyncHandler)
AmazonConnectAsyncDeletes 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.
deleteTrafficDistributionGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUseCaseResult> deleteUseCaseAsync(DeleteUseCaseRequest request)
AmazonConnectAsyncDeletes a use case from an integration association.
deleteUseCaseAsync in interface AmazonConnectAsyncpublic Future<DeleteUseCaseResult> deleteUseCaseAsync(DeleteUseCaseRequest request, AsyncHandler<DeleteUseCaseRequest,DeleteUseCaseResult> asyncHandler)
AmazonConnectAsyncDeletes a use case from an integration association.
deleteUseCaseAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonConnectAsyncDeletes 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.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteUserAsync in interface AmazonConnectAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonConnectAsyncDeletes 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.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteUserAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserHierarchyGroupResult> deleteUserHierarchyGroupAsync(DeleteUserHierarchyGroupRequest request)
AmazonConnectAsyncDeletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupAsync in interface AmazonConnectAsyncpublic Future<DeleteUserHierarchyGroupResult> deleteUserHierarchyGroupAsync(DeleteUserHierarchyGroupRequest request, AsyncHandler<DeleteUserHierarchyGroupRequest,DeleteUserHierarchyGroupResult> asyncHandler)
AmazonConnectAsyncDeletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteViewResult> deleteViewAsync(DeleteViewRequest request)
AmazonConnectAsyncDeletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteViewAsync in interface AmazonConnectAsyncpublic Future<DeleteViewResult> deleteViewAsync(DeleteViewRequest request, AsyncHandler<DeleteViewRequest,DeleteViewResult> asyncHandler)
AmazonConnectAsyncDeletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteViewAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteViewVersionResult> deleteViewVersionAsync(DeleteViewVersionRequest request)
AmazonConnectAsync
Deletes the particular version specified in ViewVersion identifier.
deleteViewVersionAsync in interface AmazonConnectAsyncpublic Future<DeleteViewVersionResult> deleteViewVersionAsync(DeleteViewVersionRequest request, AsyncHandler<DeleteViewVersionRequest,DeleteViewVersionResult> asyncHandler)
AmazonConnectAsync
Deletes the particular version specified in ViewVersion identifier.
deleteViewVersionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest request)
AmazonConnectAsyncDeletes the vocabulary that has the given identifier.
deleteVocabularyAsync in interface AmazonConnectAsyncpublic Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest request, AsyncHandler<DeleteVocabularyRequest,DeleteVocabularyResult> asyncHandler)
AmazonConnectAsyncDeletes the vocabulary that has the given identifier.
deleteVocabularyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAgentStatusResult> describeAgentStatusAsync(DescribeAgentStatusRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusAsync in interface AmazonConnectAsyncpublic Future<DescribeAgentStatusResult> describeAgentStatusAsync(DescribeAgentStatusRequest request, AsyncHandler<DescribeAgentStatusRequest,DescribeAgentStatusResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAuthenticationProfileResult> describeAuthenticationProfileAsync(DescribeAuthenticationProfileRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
describeAuthenticationProfileAsync in interface AmazonConnectAsyncpublic Future<DescribeAuthenticationProfileResult> describeAuthenticationProfileAsync(DescribeAuthenticationProfileRequest request, AsyncHandler<DescribeAuthenticationProfileRequest,DescribeAuthenticationProfileResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
describeAuthenticationProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeContactResult> describeContactAsync(DescribeContactRequest request)
AmazonConnectAsyncThis 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.
describeContactAsync in interface AmazonConnectAsyncpublic Future<DescribeContactResult> describeContactAsync(DescribeContactRequest request, AsyncHandler<DescribeContactRequest,DescribeContactResult> asyncHandler)
AmazonConnectAsyncThis 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.
describeContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeContactEvaluationResult> describeContactEvaluationAsync(DescribeContactEvaluationRequest request)
AmazonConnectAsyncDescribes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationAsync in interface AmazonConnectAsyncpublic Future<DescribeContactEvaluationResult> describeContactEvaluationAsync(DescribeContactEvaluationRequest request, AsyncHandler<DescribeContactEvaluationRequest,DescribeContactEvaluationResult> asyncHandler)
AmazonConnectAsyncDescribes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeContactFlowResult> describeContactFlowAsync(DescribeContactFlowRequest request)
AmazonConnectAsyncDescribes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED.
The PUBLISHED status will initiate validation on the content. SAVED does not initiate
validation of the content. SAVED | PUBLISHED
describeContactFlowAsync in interface AmazonConnectAsyncpublic Future<DescribeContactFlowResult> describeContactFlowAsync(DescribeContactFlowRequest request, AsyncHandler<DescribeContactFlowRequest,DescribeContactFlowResult> asyncHandler)
AmazonConnectAsyncDescribes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED.
The PUBLISHED status will initiate validation on the content. SAVED does not initiate
validation of the content. SAVED | PUBLISHED
describeContactFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeContactFlowModuleResult> describeContactFlowModuleAsync(DescribeContactFlowModuleRequest request)
AmazonConnectAsyncDescribes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
describeContactFlowModuleAsync in interface AmazonConnectAsyncpublic Future<DescribeContactFlowModuleResult> describeContactFlowModuleAsync(DescribeContactFlowModuleRequest request, AsyncHandler<DescribeContactFlowModuleRequest,DescribeContactFlowModuleResult> asyncHandler)
AmazonConnectAsyncDescribes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
describeContactFlowModuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEvaluationFormResult> describeEvaluationFormAsync(DescribeEvaluationFormRequest request)
AmazonConnectAsyncDescribes 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.
describeEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<DescribeEvaluationFormResult> describeEvaluationFormAsync(DescribeEvaluationFormRequest request, AsyncHandler<DescribeEvaluationFormRequest,DescribeEvaluationFormResult> asyncHandler)
AmazonConnectAsyncDescribes 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.
describeEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeHoursOfOperationResult> describeHoursOfOperationAsync(DescribeHoursOfOperationRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationAsync in interface AmazonConnectAsyncpublic Future<DescribeHoursOfOperationResult> describeHoursOfOperationAsync(DescribeHoursOfOperationRequest request, AsyncHandler<DescribeHoursOfOperationRequest,DescribeHoursOfOperationResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeInstanceResult> describeInstanceAsync(DescribeInstanceRequest request)
AmazonConnectAsyncThis 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.
describeInstanceAsync in interface AmazonConnectAsyncpublic Future<DescribeInstanceResult> describeInstanceAsync(DescribeInstanceRequest request, AsyncHandler<DescribeInstanceRequest,DescribeInstanceResult> asyncHandler)
AmazonConnectAsyncThis 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.
describeInstanceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeInstanceAttributeResult> describeInstanceAttributeAsync(DescribeInstanceAttributeRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeAsync in interface AmazonConnectAsyncpublic Future<DescribeInstanceAttributeResult> describeInstanceAttributeAsync(DescribeInstanceAttributeRequest request, AsyncHandler<DescribeInstanceAttributeRequest,DescribeInstanceAttributeResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeInstanceStorageConfigResult> describeInstanceStorageConfigAsync(DescribeInstanceStorageConfigRequest request)
AmazonConnectAsyncThis 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.
describeInstanceStorageConfigAsync in interface AmazonConnectAsyncpublic Future<DescribeInstanceStorageConfigResult> describeInstanceStorageConfigAsync(DescribeInstanceStorageConfigRequest request, AsyncHandler<DescribeInstanceStorageConfigRequest,DescribeInstanceStorageConfigResult> asyncHandler)
AmazonConnectAsyncThis 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.
describeInstanceStorageConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePhoneNumberResult> describePhoneNumberAsync(DescribePhoneNumberRequest request)
AmazonConnectAsyncGets 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.
describePhoneNumberAsync in interface AmazonConnectAsyncpublic Future<DescribePhoneNumberResult> describePhoneNumberAsync(DescribePhoneNumberRequest request, AsyncHandler<DescribePhoneNumberRequest,DescribePhoneNumberResult> asyncHandler)
AmazonConnectAsyncGets 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.
describePhoneNumberAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePredefinedAttributeResult> describePredefinedAttributeAsync(DescribePredefinedAttributeRequest request)
AmazonConnectAsyncDescribes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttributeAsync in interface AmazonConnectAsyncpublic Future<DescribePredefinedAttributeResult> describePredefinedAttributeAsync(DescribePredefinedAttributeRequest request, AsyncHandler<DescribePredefinedAttributeRequest,DescribePredefinedAttributeResult> asyncHandler)
AmazonConnectAsyncDescribes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePromptResult> describePromptAsync(DescribePromptRequest request)
AmazonConnectAsyncDescribes the prompt.
describePromptAsync in interface AmazonConnectAsyncpublic Future<DescribePromptResult> describePromptAsync(DescribePromptRequest request, AsyncHandler<DescribePromptRequest,DescribePromptResult> asyncHandler)
AmazonConnectAsyncDescribes the prompt.
describePromptAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQueueResult> describeQueueAsync(DescribeQueueRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueAsync in interface AmazonConnectAsyncpublic Future<DescribeQueueResult> describeQueueAsync(DescribeQueueRequest request, AsyncHandler<DescribeQueueRequest,DescribeQueueResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQuickConnectResult> describeQuickConnectAsync(DescribeQuickConnectRequest request)
AmazonConnectAsyncDescribes the quick connect.
describeQuickConnectAsync in interface AmazonConnectAsyncpublic Future<DescribeQuickConnectResult> describeQuickConnectAsync(DescribeQuickConnectRequest request, AsyncHandler<DescribeQuickConnectRequest,DescribeQuickConnectResult> asyncHandler)
AmazonConnectAsyncDescribes the quick connect.
describeQuickConnectAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRoutingProfileResult> describeRoutingProfileAsync(DescribeRoutingProfileRequest request)
AmazonConnectAsyncDescribes the specified routing profile.
describeRoutingProfileAsync in interface AmazonConnectAsyncpublic Future<DescribeRoutingProfileResult> describeRoutingProfileAsync(DescribeRoutingProfileRequest request, AsyncHandler<DescribeRoutingProfileRequest,DescribeRoutingProfileResult> asyncHandler)
AmazonConnectAsyncDescribes the specified routing profile.
describeRoutingProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request)
AmazonConnectAsyncDescribes a rule for the specified Amazon Connect instance.
describeRuleAsync in interface AmazonConnectAsyncpublic Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request, AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
AmazonConnectAsyncDescribes a rule for the specified Amazon Connect instance.
describeRuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest request)
AmazonConnectAsyncGets basic information about the security profle.
describeSecurityProfileAsync in interface AmazonConnectAsyncpublic Future<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest request, AsyncHandler<DescribeSecurityProfileRequest,DescribeSecurityProfileResult> asyncHandler)
AmazonConnectAsyncGets basic information about the security profle.
describeSecurityProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTrafficDistributionGroupResult> describeTrafficDistributionGroupAsync(DescribeTrafficDistributionGroupRequest request)
AmazonConnectAsyncGets details and status of a traffic distribution group.
describeTrafficDistributionGroupAsync in interface AmazonConnectAsyncpublic Future<DescribeTrafficDistributionGroupResult> describeTrafficDistributionGroupAsync(DescribeTrafficDistributionGroupRequest request, AsyncHandler<DescribeTrafficDistributionGroupRequest,DescribeTrafficDistributionGroupResult> asyncHandler)
AmazonConnectAsyncGets details and status of a traffic distribution group.
describeTrafficDistributionGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AmazonConnectAsyncDescribes the specified user. 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.
describeUserAsync in interface AmazonConnectAsyncpublic Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonConnectAsyncDescribes the specified user. 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.
describeUserAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest request)
AmazonConnectAsyncDescribes the specified hierarchy group.
describeUserHierarchyGroupAsync in interface AmazonConnectAsyncpublic Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest request, AsyncHandler<DescribeUserHierarchyGroupRequest,DescribeUserHierarchyGroupResult> asyncHandler)
AmazonConnectAsyncDescribes the specified hierarchy group.
describeUserHierarchyGroupAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest request)
AmazonConnectAsyncDescribes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureAsync in interface AmazonConnectAsyncpublic Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest request, AsyncHandler<DescribeUserHierarchyStructureRequest,DescribeUserHierarchyStructureResult> asyncHandler)
AmazonConnectAsyncDescribes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeViewResult> describeViewAsync(DescribeViewRequest request)
AmazonConnectAsyncRetrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is
either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is
not supplied, then $LATEST is assumed for customer managed views and an error is returned if there
is no published content available. Version 1 is assumed for Amazon Web Services managed views.
describeViewAsync in interface AmazonConnectAsyncpublic Future<DescribeViewResult> describeViewAsync(DescribeViewRequest request, AsyncHandler<DescribeViewRequest,DescribeViewResult> asyncHandler)
AmazonConnectAsyncRetrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is
either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is
not supplied, then $LATEST is assumed for customer managed views and an error is returned if there
is no published content available. Version 1 is assumed for Amazon Web Services managed views.
describeViewAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeVocabularyResult> describeVocabularyAsync(DescribeVocabularyRequest request)
AmazonConnectAsyncDescribes the specified vocabulary.
describeVocabularyAsync in interface AmazonConnectAsyncpublic Future<DescribeVocabularyResult> describeVocabularyAsync(DescribeVocabularyRequest request, AsyncHandler<DescribeVocabularyRequest,DescribeVocabularyResult> asyncHandler)
AmazonConnectAsyncDescribes the specified vocabulary.
describeVocabularyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateAnalyticsDataSetResult> disassociateAnalyticsDataSetAsync(DisassociateAnalyticsDataSetRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSetAsync in interface AmazonConnectAsyncpublic Future<DisassociateAnalyticsDataSetResult> disassociateAnalyticsDataSetAsync(DisassociateAnalyticsDataSetRequest request, AsyncHandler<DisassociateAnalyticsDataSetRequest,DisassociateAnalyticsDataSetResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSetAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateApprovedOriginResult> disassociateApprovedOriginAsync(DisassociateApprovedOriginRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginAsync in interface AmazonConnectAsyncpublic Future<DisassociateApprovedOriginResult> disassociateApprovedOriginAsync(DisassociateApprovedOriginRequest request, AsyncHandler<DisassociateApprovedOriginRequest,DisassociateApprovedOriginResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateBotResult> disassociateBotAsync(DisassociateBotRequest request)
AmazonConnectAsyncThis 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.
disassociateBotAsync in interface AmazonConnectAsyncpublic Future<DisassociateBotResult> disassociateBotAsync(DisassociateBotRequest request, AsyncHandler<DisassociateBotRequest,DisassociateBotResult> asyncHandler)
AmazonConnectAsyncThis 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.
disassociateBotAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateFlowResult> disassociateFlowAsync(DisassociateFlowRequest request)
AmazonConnectAsyncDisassociates a connect resource from a flow.
disassociateFlowAsync in interface AmazonConnectAsyncpublic Future<DisassociateFlowResult> disassociateFlowAsync(DisassociateFlowRequest request, AsyncHandler<DisassociateFlowRequest,DisassociateFlowResult> asyncHandler)
AmazonConnectAsyncDisassociates a connect resource from a flow.
disassociateFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateInstanceStorageConfigResult> disassociateInstanceStorageConfigAsync(DisassociateInstanceStorageConfigRequest request)
AmazonConnectAsyncThis 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.
disassociateInstanceStorageConfigAsync in interface AmazonConnectAsyncpublic Future<DisassociateInstanceStorageConfigResult> disassociateInstanceStorageConfigAsync(DisassociateInstanceStorageConfigRequest request, AsyncHandler<DisassociateInstanceStorageConfigRequest,DisassociateInstanceStorageConfigResult> asyncHandler)
AmazonConnectAsyncThis 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.
disassociateInstanceStorageConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateLambdaFunctionResult> disassociateLambdaFunctionAsync(DisassociateLambdaFunctionRequest request)
AmazonConnectAsyncThis 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.
disassociateLambdaFunctionAsync in interface AmazonConnectAsyncpublic Future<DisassociateLambdaFunctionResult> disassociateLambdaFunctionAsync(DisassociateLambdaFunctionRequest request, AsyncHandler<DisassociateLambdaFunctionRequest,DisassociateLambdaFunctionResult> asyncHandler)
AmazonConnectAsyncThis 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.
disassociateLambdaFunctionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateLexBotResult> disassociateLexBotAsync(DisassociateLexBotRequest request)
AmazonConnectAsyncThis 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.
disassociateLexBotAsync in interface AmazonConnectAsyncpublic Future<DisassociateLexBotResult> disassociateLexBotAsync(DisassociateLexBotRequest request, AsyncHandler<DisassociateLexBotRequest,DisassociateLexBotResult> asyncHandler)
AmazonConnectAsyncThis 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.
disassociateLexBotAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociatePhoneNumberContactFlowResult> disassociatePhoneNumberContactFlowAsync(DisassociatePhoneNumberContactFlowRequest request)
AmazonConnectAsyncRemoves 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.
disassociatePhoneNumberContactFlowAsync in interface AmazonConnectAsyncpublic Future<DisassociatePhoneNumberContactFlowResult> disassociatePhoneNumberContactFlowAsync(DisassociatePhoneNumberContactFlowRequest request, AsyncHandler<DisassociatePhoneNumberContactFlowRequest,DisassociatePhoneNumberContactFlowResult> asyncHandler)
AmazonConnectAsyncRemoves 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.
disassociatePhoneNumberContactFlowAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateQueueQuickConnectsResult> disassociateQueueQuickConnectsAsync(DisassociateQueueQuickConnectsRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsAsync in interface AmazonConnectAsyncpublic Future<DisassociateQueueQuickConnectsResult> disassociateQueueQuickConnectsAsync(DisassociateQueueQuickConnectsRequest request, AsyncHandler<DisassociateQueueQuickConnectsRequest,DisassociateQueueQuickConnectsResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateRoutingProfileQueuesResult> disassociateRoutingProfileQueuesAsync(DisassociateRoutingProfileQueuesRequest request)
AmazonConnectAsyncDisassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesAsync in interface AmazonConnectAsyncpublic Future<DisassociateRoutingProfileQueuesResult> disassociateRoutingProfileQueuesAsync(DisassociateRoutingProfileQueuesRequest request, AsyncHandler<DisassociateRoutingProfileQueuesRequest,DisassociateRoutingProfileQueuesResult> asyncHandler)
AmazonConnectAsyncDisassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateSecurityKeyResult> disassociateSecurityKeyAsync(DisassociateSecurityKeyRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyAsync in interface AmazonConnectAsyncpublic Future<DisassociateSecurityKeyResult> disassociateSecurityKeyAsync(DisassociateSecurityKeyRequest request, AsyncHandler<DisassociateSecurityKeyRequest,DisassociateSecurityKeyResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateTrafficDistributionGroupUserResult> disassociateTrafficDistributionGroupUserAsync(DisassociateTrafficDistributionGroupUserRequest request)
AmazonConnectAsyncDisassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserAsync in interface AmazonConnectAsyncpublic Future<DisassociateTrafficDistributionGroupUserResult> disassociateTrafficDistributionGroupUserAsync(DisassociateTrafficDistributionGroupUserRequest request, AsyncHandler<DisassociateTrafficDistributionGroupUserRequest,DisassociateTrafficDistributionGroupUserResult> asyncHandler)
AmazonConnectAsyncDisassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateUserProficienciesResult> disassociateUserProficienciesAsync(DisassociateUserProficienciesRequest request)
AmazonConnectAsyncDisassociates a set of proficiencies from a user.
disassociateUserProficienciesAsync in interface AmazonConnectAsyncpublic Future<DisassociateUserProficienciesResult> disassociateUserProficienciesAsync(DisassociateUserProficienciesRequest request, AsyncHandler<DisassociateUserProficienciesRequest,DisassociateUserProficienciesResult> asyncHandler)
AmazonConnectAsyncDisassociates a set of proficiencies from a user.
disassociateUserProficienciesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DismissUserContactResult> dismissUserContactAsync(DismissUserContactRequest request)
AmazonConnectAsync
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.
dismissUserContactAsync in interface AmazonConnectAsyncpublic Future<DismissUserContactResult> dismissUserContactAsync(DismissUserContactRequest request, AsyncHandler<DismissUserContactRequest,DismissUserContactResult> asyncHandler)
AmazonConnectAsync
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.
dismissUserContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetAttachedFileResult> getAttachedFileAsync(GetAttachedFileRequest request)
AmazonConnectAsync
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the
attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
getAttachedFileAsync in interface AmazonConnectAsyncrequest - Request to GetAttachedFile API.public Future<GetAttachedFileResult> getAttachedFileAsync(GetAttachedFileRequest request, AsyncHandler<GetAttachedFileRequest,GetAttachedFileResult> asyncHandler)
AmazonConnectAsync
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the
attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
getAttachedFileAsync in interface AmazonConnectAsyncrequest - Request to GetAttachedFile API.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest request)
AmazonConnectAsyncRetrieves the contact attributes for the specified contact.
getContactAttributesAsync in interface AmazonConnectAsyncpublic Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest request, AsyncHandler<GetContactAttributesRequest,GetContactAttributesResult> asyncHandler)
AmazonConnectAsyncRetrieves the contact attributes for the specified contact.
getContactAttributesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest request)
AmazonConnectAsyncGets 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.
getCurrentMetricDataAsync in interface AmazonConnectAsyncpublic Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest request, AsyncHandler<GetCurrentMetricDataRequest,GetCurrentMetricDataResult> asyncHandler)
AmazonConnectAsyncGets 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.
getCurrentMetricDataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCurrentUserDataResult> getCurrentUserDataAsync(GetCurrentUserDataRequest request)
AmazonConnectAsyncGets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataAsync in interface AmazonConnectAsyncpublic Future<GetCurrentUserDataResult> getCurrentUserDataAsync(GetCurrentUserDataRequest request, AsyncHandler<GetCurrentUserDataRequest,GetCurrentUserDataResult> asyncHandler)
AmazonConnectAsyncGets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest request)
AmazonConnectAsyncSupports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
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
getFederationTokenAsync in interface AmazonConnectAsyncpublic Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest request, AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
AmazonConnectAsyncSupports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
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
getFederationTokenAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetFlowAssociationResult> getFlowAssociationAsync(GetFlowAssociationRequest request)
AmazonConnectAsyncRetrieves the flow associated for a given resource.
getFlowAssociationAsync in interface AmazonConnectAsyncpublic Future<GetFlowAssociationResult> getFlowAssociationAsync(GetFlowAssociationRequest request, AsyncHandler<GetFlowAssociationRequest,GetFlowAssociationResult> asyncHandler)
AmazonConnectAsyncRetrieves the flow associated for a given resource.
getFlowAssociationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest request)
AmazonConnectAsyncGets 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.
We recommend using the GetMetricDataV2 API.
It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at
varying intervals. You can also use it to build custom dashboards to measure historical queue and agent
performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by
day, to see how contact volume changed per day of the week.
getMetricDataAsync in interface AmazonConnectAsyncpublic Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest request, AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
AmazonConnectAsyncGets 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.
We recommend using the GetMetricDataV2 API.
It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at
varying intervals. You can also use it to build custom dashboards to measure historical queue and agent
performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by
day, to see how contact volume changed per day of the week.
getMetricDataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetMetricDataV2Result> getMetricDataV2Async(GetMetricDataV2Request request)
AmazonConnectAsyncGets 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 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and
GetMetricData, see Historical
metrics definitions in the Amazon Connect Administrator Guide.
getMetricDataV2Async in interface AmazonConnectAsyncpublic Future<GetMetricDataV2Result> getMetricDataV2Async(GetMetricDataV2Request request, AsyncHandler<GetMetricDataV2Request,GetMetricDataV2Result> asyncHandler)
AmazonConnectAsyncGets 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 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and
GetMetricData, see Historical
metrics definitions in the Amazon Connect Administrator Guide.
getMetricDataV2Async in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPromptFileResult> getPromptFileAsync(GetPromptFileRequest request)
AmazonConnectAsyncGets the prompt file.
getPromptFileAsync in interface AmazonConnectAsyncpublic Future<GetPromptFileResult> getPromptFileAsync(GetPromptFileRequest request, AsyncHandler<GetPromptFileRequest,GetPromptFileResult> asyncHandler)
AmazonConnectAsyncGets the prompt file.
getPromptFileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTaskTemplateResult> getTaskTemplateAsync(GetTaskTemplateRequest request)
AmazonConnectAsyncGets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateAsync in interface AmazonConnectAsyncpublic Future<GetTaskTemplateResult> getTaskTemplateAsync(GetTaskTemplateRequest request, AsyncHandler<GetTaskTemplateRequest,GetTaskTemplateResult> asyncHandler)
AmazonConnectAsyncGets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTrafficDistributionResult> getTrafficDistributionAsync(GetTrafficDistributionRequest request)
AmazonConnectAsyncRetrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionAsync in interface AmazonConnectAsyncpublic Future<GetTrafficDistributionResult> getTrafficDistributionAsync(GetTrafficDistributionRequest request, AsyncHandler<GetTrafficDistributionRequest,GetTrafficDistributionResult> asyncHandler)
AmazonConnectAsyncRetrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ImportPhoneNumberResult> importPhoneNumberAsync(ImportPhoneNumberRequest request)
AmazonConnectAsyncImports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber
API to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 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.
importPhoneNumberAsync in interface AmazonConnectAsyncpublic Future<ImportPhoneNumberResult> importPhoneNumberAsync(ImportPhoneNumberRequest request, AsyncHandler<ImportPhoneNumberRequest,ImportPhoneNumberResult> asyncHandler)
AmazonConnectAsyncImports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber
API to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 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.
importPhoneNumberAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAgentStatusesResult> listAgentStatusesAsync(ListAgentStatusesRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesAsync in interface AmazonConnectAsyncpublic Future<ListAgentStatusesResult> listAgentStatusesAsync(ListAgentStatusesRequest request, AsyncHandler<ListAgentStatusesRequest,ListAgentStatusesResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAnalyticsDataAssociationsResult> listAnalyticsDataAssociationsAsync(ListAnalyticsDataAssociationsRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
listAnalyticsDataAssociationsAsync in interface AmazonConnectAsyncpublic Future<ListAnalyticsDataAssociationsResult> listAnalyticsDataAssociationsAsync(ListAnalyticsDataAssociationsRequest request, AsyncHandler<ListAnalyticsDataAssociationsRequest,ListAnalyticsDataAssociationsResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
listAnalyticsDataAssociationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListApprovedOriginsResult> listApprovedOriginsAsync(ListApprovedOriginsRequest request)
AmazonConnectAsyncThis 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.
listApprovedOriginsAsync in interface AmazonConnectAsyncpublic Future<ListApprovedOriginsResult> listApprovedOriginsAsync(ListApprovedOriginsRequest request, AsyncHandler<ListApprovedOriginsRequest,ListApprovedOriginsResult> asyncHandler)
AmazonConnectAsyncThis 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.
listApprovedOriginsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAuthenticationProfilesResult> listAuthenticationProfilesAsync(ListAuthenticationProfilesRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
listAuthenticationProfilesAsync in interface AmazonConnectAsyncpublic Future<ListAuthenticationProfilesResult> listAuthenticationProfilesAsync(ListAuthenticationProfilesRequest request, AsyncHandler<ListAuthenticationProfilesRequest,ListAuthenticationProfilesResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
listAuthenticationProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListBotsResult> listBotsAsync(ListBotsRequest request)
AmazonConnectAsyncThis 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.
listBotsAsync in interface AmazonConnectAsyncpublic Future<ListBotsResult> listBotsAsync(ListBotsRequest request, AsyncHandler<ListBotsRequest,ListBotsResult> asyncHandler)
AmazonConnectAsyncThis 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.
listBotsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListContactEvaluationsResult> listContactEvaluationsAsync(ListContactEvaluationsRequest request)
AmazonConnectAsyncLists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsAsync in interface AmazonConnectAsyncpublic Future<ListContactEvaluationsResult> listContactEvaluationsAsync(ListContactEvaluationsRequest request, AsyncHandler<ListContactEvaluationsRequest,ListContactEvaluationsResult> asyncHandler)
AmazonConnectAsyncLists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListContactFlowModulesResult> listContactFlowModulesAsync(ListContactFlowModulesRequest request)
AmazonConnectAsyncProvides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesAsync in interface AmazonConnectAsyncpublic Future<ListContactFlowModulesResult> listContactFlowModulesAsync(ListContactFlowModulesRequest request, AsyncHandler<ListContactFlowModulesRequest,ListContactFlowModulesResult> asyncHandler)
AmazonConnectAsyncProvides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListContactFlowsResult> listContactFlowsAsync(ListContactFlowsRequest request)
AmazonConnectAsyncProvides 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.
listContactFlowsAsync in interface AmazonConnectAsyncpublic Future<ListContactFlowsResult> listContactFlowsAsync(ListContactFlowsRequest request, AsyncHandler<ListContactFlowsRequest,ListContactFlowsResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listContactFlowsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListContactReferencesResult> listContactReferencesAsync(ListContactReferencesRequest request)
AmazonConnectAsyncThis 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.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferencesAsync in interface AmazonConnectAsyncpublic Future<ListContactReferencesResult> listContactReferencesAsync(ListContactReferencesRequest request, AsyncHandler<ListContactReferencesRequest,ListContactReferencesResult> asyncHandler)
AmazonConnectAsyncThis 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.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferencesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDefaultVocabulariesResult> listDefaultVocabulariesAsync(ListDefaultVocabulariesRequest request)
AmazonConnectAsyncLists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesAsync in interface AmazonConnectAsyncpublic Future<ListDefaultVocabulariesResult> listDefaultVocabulariesAsync(ListDefaultVocabulariesRequest request, AsyncHandler<ListDefaultVocabulariesRequest,ListDefaultVocabulariesResult> asyncHandler)
AmazonConnectAsyncLists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEvaluationFormVersionsResult> listEvaluationFormVersionsAsync(ListEvaluationFormVersionsRequest request)
AmazonConnectAsyncLists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsAsync in interface AmazonConnectAsyncpublic Future<ListEvaluationFormVersionsResult> listEvaluationFormVersionsAsync(ListEvaluationFormVersionsRequest request, AsyncHandler<ListEvaluationFormVersionsRequest,ListEvaluationFormVersionsResult> asyncHandler)
AmazonConnectAsyncLists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEvaluationFormsResult> listEvaluationFormsAsync(ListEvaluationFormsRequest request)
AmazonConnectAsyncLists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsAsync in interface AmazonConnectAsyncpublic Future<ListEvaluationFormsResult> listEvaluationFormsAsync(ListEvaluationFormsRequest request, AsyncHandler<ListEvaluationFormsRequest,ListEvaluationFormsResult> asyncHandler)
AmazonConnectAsyncLists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFlowAssociationsResult> listFlowAssociationsAsync(ListFlowAssociationsRequest request)
AmazonConnectAsyncList the flow association based on the filters.
listFlowAssociationsAsync in interface AmazonConnectAsyncpublic Future<ListFlowAssociationsResult> listFlowAssociationsAsync(ListFlowAssociationsRequest request, AsyncHandler<ListFlowAssociationsRequest,ListFlowAssociationsResult> asyncHandler)
AmazonConnectAsyncList the flow association based on the filters.
listFlowAssociationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListHoursOfOperationsResult> listHoursOfOperationsAsync(ListHoursOfOperationsRequest request)
AmazonConnectAsyncProvides 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.
listHoursOfOperationsAsync in interface AmazonConnectAsyncpublic Future<ListHoursOfOperationsResult> listHoursOfOperationsAsync(ListHoursOfOperationsRequest request, AsyncHandler<ListHoursOfOperationsRequest,ListHoursOfOperationsResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listHoursOfOperationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListInstanceAttributesResult> listInstanceAttributesAsync(ListInstanceAttributesRequest request)
AmazonConnectAsyncThis 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.
listInstanceAttributesAsync in interface AmazonConnectAsyncpublic Future<ListInstanceAttributesResult> listInstanceAttributesAsync(ListInstanceAttributesRequest request, AsyncHandler<ListInstanceAttributesRequest,ListInstanceAttributesResult> asyncHandler)
AmazonConnectAsyncThis 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.
listInstanceAttributesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListInstanceStorageConfigsResult> listInstanceStorageConfigsAsync(ListInstanceStorageConfigsRequest request)
AmazonConnectAsyncThis 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.
listInstanceStorageConfigsAsync in interface AmazonConnectAsyncpublic Future<ListInstanceStorageConfigsResult> listInstanceStorageConfigsAsync(ListInstanceStorageConfigsRequest request, AsyncHandler<ListInstanceStorageConfigsRequest,ListInstanceStorageConfigsResult> asyncHandler)
AmazonConnectAsyncThis 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.
listInstanceStorageConfigsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListInstancesResult> listInstancesAsync(ListInstancesRequest request)
AmazonConnectAsyncThis 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.
listInstancesAsync in interface AmazonConnectAsyncpublic Future<ListInstancesResult> listInstancesAsync(ListInstancesRequest request, AsyncHandler<ListInstancesRequest,ListInstancesResult> asyncHandler)
AmazonConnectAsyncThis 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.
listInstancesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIntegrationAssociationsResult> listIntegrationAssociationsAsync(ListIntegrationAssociationsRequest request)
AmazonConnectAsyncProvides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsAsync in interface AmazonConnectAsyncpublic Future<ListIntegrationAssociationsResult> listIntegrationAssociationsAsync(ListIntegrationAssociationsRequest request, AsyncHandler<ListIntegrationAssociationsRequest,ListIntegrationAssociationsResult> asyncHandler)
AmazonConnectAsyncProvides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLambdaFunctionsResult> listLambdaFunctionsAsync(ListLambdaFunctionsRequest request)
AmazonConnectAsyncThis 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.
listLambdaFunctionsAsync in interface AmazonConnectAsyncpublic Future<ListLambdaFunctionsResult> listLambdaFunctionsAsync(ListLambdaFunctionsRequest request, AsyncHandler<ListLambdaFunctionsRequest,ListLambdaFunctionsResult> asyncHandler)
AmazonConnectAsyncThis 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.
listLambdaFunctionsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLexBotsResult> listLexBotsAsync(ListLexBotsRequest request)
AmazonConnectAsyncThis 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.
listLexBotsAsync in interface AmazonConnectAsyncpublic Future<ListLexBotsResult> listLexBotsAsync(ListLexBotsRequest request, AsyncHandler<ListLexBotsRequest,ListLexBotsResult> asyncHandler)
AmazonConnectAsyncThis 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.
listLexBotsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPhoneNumbersResult> listPhoneNumbersAsync(ListPhoneNumbersRequest request)
AmazonConnectAsyncProvides 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.
We recommend using ListPhoneNumbersV2
to return phone number types. ListPhoneNumbers doesn't support number types UIFN,
SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of
those types, it incorrectly lists them as TOLL_FREE or DID.
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.
listPhoneNumbersAsync in interface AmazonConnectAsyncpublic Future<ListPhoneNumbersResult> listPhoneNumbersAsync(ListPhoneNumbersRequest request, AsyncHandler<ListPhoneNumbersRequest,ListPhoneNumbersResult> asyncHandler)
AmazonConnectAsyncProvides 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.
We recommend using ListPhoneNumbersV2
to return phone number types. ListPhoneNumbers doesn't support number types UIFN,
SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of
those types, it incorrectly lists them as TOLL_FREE or DID.
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.
listPhoneNumbersAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPhoneNumbersV2Result> listPhoneNumbersV2Async(ListPhoneNumbersV2Request request)
AmazonConnectAsync
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.
listPhoneNumbersV2Async in interface AmazonConnectAsyncpublic Future<ListPhoneNumbersV2Result> listPhoneNumbersV2Async(ListPhoneNumbersV2Request request, AsyncHandler<ListPhoneNumbersV2Request,ListPhoneNumbersV2Result> asyncHandler)
AmazonConnectAsync
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.
listPhoneNumbersV2Async in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPredefinedAttributesResult> listPredefinedAttributesAsync(ListPredefinedAttributesRequest request)
AmazonConnectAsyncLists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributesAsync in interface AmazonConnectAsyncpublic Future<ListPredefinedAttributesResult> listPredefinedAttributesAsync(ListPredefinedAttributesRequest request, AsyncHandler<ListPredefinedAttributesRequest,ListPredefinedAttributesResult> asyncHandler)
AmazonConnectAsyncLists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPromptsResult> listPromptsAsync(ListPromptsRequest request)
AmazonConnectAsyncProvides information about the prompts for the specified Amazon Connect instance.
listPromptsAsync in interface AmazonConnectAsyncpublic Future<ListPromptsResult> listPromptsAsync(ListPromptsRequest request, AsyncHandler<ListPromptsRequest,ListPromptsResult> asyncHandler)
AmazonConnectAsyncProvides information about the prompts for the specified Amazon Connect instance.
listPromptsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQueueQuickConnectsResult> listQueueQuickConnectsAsync(ListQueueQuickConnectsRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsAsync in interface AmazonConnectAsyncpublic Future<ListQueueQuickConnectsResult> listQueueQuickConnectsAsync(ListQueueQuickConnectsRequest request, AsyncHandler<ListQueueQuickConnectsRequest,ListQueueQuickConnectsResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest request)
AmazonConnectAsyncProvides 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.
listQueuesAsync in interface AmazonConnectAsyncpublic Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest request, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQuickConnectsResult> listQuickConnectsAsync(ListQuickConnectsRequest request)
AmazonConnectAsyncProvides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsAsync in interface AmazonConnectAsyncpublic Future<ListQuickConnectsResult> listQuickConnectsAsync(ListQuickConnectsRequest request, AsyncHandler<ListQuickConnectsRequest,ListQuickConnectsResult> asyncHandler)
AmazonConnectAsyncProvides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRealtimeContactAnalysisSegmentsV2Result> listRealtimeContactAnalysisSegmentsV2Async(ListRealtimeContactAnalysisSegmentsV2Request request)
AmazonConnectAsyncProvides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2Async in interface AmazonConnectAsyncpublic Future<ListRealtimeContactAnalysisSegmentsV2Result> listRealtimeContactAnalysisSegmentsV2Async(ListRealtimeContactAnalysisSegmentsV2Request request, AsyncHandler<ListRealtimeContactAnalysisSegmentsV2Request,ListRealtimeContactAnalysisSegmentsV2Result> asyncHandler)
AmazonConnectAsyncProvides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2Async in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRoutingProfileQueuesResult> listRoutingProfileQueuesAsync(ListRoutingProfileQueuesRequest request)
AmazonConnectAsyncLists the queues associated with a routing profile.
listRoutingProfileQueuesAsync in interface AmazonConnectAsyncpublic Future<ListRoutingProfileQueuesResult> listRoutingProfileQueuesAsync(ListRoutingProfileQueuesRequest request, AsyncHandler<ListRoutingProfileQueuesRequest,ListRoutingProfileQueuesResult> asyncHandler)
AmazonConnectAsyncLists the queues associated with a routing profile.
listRoutingProfileQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest request)
AmazonConnectAsyncProvides 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.
listRoutingProfilesAsync in interface AmazonConnectAsyncpublic Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest request, AsyncHandler<ListRoutingProfilesRequest,ListRoutingProfilesResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listRoutingProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRulesResult> listRulesAsync(ListRulesRequest request)
AmazonConnectAsyncList all rules for the specified Amazon Connect instance.
listRulesAsync in interface AmazonConnectAsyncpublic Future<ListRulesResult> listRulesAsync(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
AmazonConnectAsyncList all rules for the specified Amazon Connect instance.
listRulesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSecurityKeysResult> listSecurityKeysAsync(ListSecurityKeysRequest request)
AmazonConnectAsyncThis 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.
listSecurityKeysAsync in interface AmazonConnectAsyncpublic Future<ListSecurityKeysResult> listSecurityKeysAsync(ListSecurityKeysRequest request, AsyncHandler<ListSecurityKeysRequest,ListSecurityKeysResult> asyncHandler)
AmazonConnectAsyncThis 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.
listSecurityKeysAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSecurityProfileApplicationsResult> listSecurityProfileApplicationsAsync(ListSecurityProfileApplicationsRequest request)
AmazonConnectAsyncReturns a list of third-party applications in a specific security profile.
listSecurityProfileApplicationsAsync in interface AmazonConnectAsyncpublic Future<ListSecurityProfileApplicationsResult> listSecurityProfileApplicationsAsync(ListSecurityProfileApplicationsRequest request, AsyncHandler<ListSecurityProfileApplicationsRequest,ListSecurityProfileApplicationsResult> asyncHandler)
AmazonConnectAsyncReturns a list of third-party applications in a specific security profile.
listSecurityProfileApplicationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSecurityProfilePermissionsResult> listSecurityProfilePermissionsAsync(ListSecurityProfilePermissionsRequest request)
AmazonConnectAsyncLists the permissions granted to a security profile.
listSecurityProfilePermissionsAsync in interface AmazonConnectAsyncpublic Future<ListSecurityProfilePermissionsResult> listSecurityProfilePermissionsAsync(ListSecurityProfilePermissionsRequest request, AsyncHandler<ListSecurityProfilePermissionsRequest,ListSecurityProfilePermissionsResult> asyncHandler)
AmazonConnectAsyncLists the permissions granted to a security profile.
listSecurityProfilePermissionsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest request)
AmazonConnectAsyncProvides 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.
listSecurityProfilesAsync in interface AmazonConnectAsyncpublic Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest request, AsyncHandler<ListSecurityProfilesRequest,ListSecurityProfilesResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listSecurityProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonConnectAsyncLists 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.
listTagsForResourceAsync in interface AmazonConnectAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonConnectAsyncLists 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.
listTagsForResourceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTaskTemplatesResult> listTaskTemplatesAsync(ListTaskTemplatesRequest request)
AmazonConnectAsyncLists task templates for the specified Amazon Connect instance.
listTaskTemplatesAsync in interface AmazonConnectAsyncpublic Future<ListTaskTemplatesResult> listTaskTemplatesAsync(ListTaskTemplatesRequest request, AsyncHandler<ListTaskTemplatesRequest,ListTaskTemplatesResult> asyncHandler)
AmazonConnectAsyncLists task templates for the specified Amazon Connect instance.
listTaskTemplatesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTrafficDistributionGroupUsersResult> listTrafficDistributionGroupUsersAsync(ListTrafficDistributionGroupUsersRequest request)
AmazonConnectAsyncLists traffic distribution group users.
listTrafficDistributionGroupUsersAsync in interface AmazonConnectAsyncpublic Future<ListTrafficDistributionGroupUsersResult> listTrafficDistributionGroupUsersAsync(ListTrafficDistributionGroupUsersRequest request, AsyncHandler<ListTrafficDistributionGroupUsersRequest,ListTrafficDistributionGroupUsersResult> asyncHandler)
AmazonConnectAsyncLists traffic distribution group users.
listTrafficDistributionGroupUsersAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTrafficDistributionGroupsResult> listTrafficDistributionGroupsAsync(ListTrafficDistributionGroupsRequest request)
AmazonConnectAsyncLists traffic distribution groups.
listTrafficDistributionGroupsAsync in interface AmazonConnectAsyncpublic Future<ListTrafficDistributionGroupsResult> listTrafficDistributionGroupsAsync(ListTrafficDistributionGroupsRequest request, AsyncHandler<ListTrafficDistributionGroupsRequest,ListTrafficDistributionGroupsResult> asyncHandler)
AmazonConnectAsyncLists traffic distribution groups.
listTrafficDistributionGroupsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUseCasesResult> listUseCasesAsync(ListUseCasesRequest request)
AmazonConnectAsyncLists the use cases for the integration association.
listUseCasesAsync in interface AmazonConnectAsyncrequest - Provides summary information about the use cases for the specified integration association.public Future<ListUseCasesResult> listUseCasesAsync(ListUseCasesRequest request, AsyncHandler<ListUseCasesRequest,ListUseCasesResult> asyncHandler)
AmazonConnectAsyncLists the use cases for the integration association.
listUseCasesAsync in interface AmazonConnectAsyncrequest - Provides summary information about the use cases for the specified integration association.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest request)
AmazonConnectAsyncProvides 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.
listUserHierarchyGroupsAsync in interface AmazonConnectAsyncpublic Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest request, AsyncHandler<ListUserHierarchyGroupsRequest,ListUserHierarchyGroupsResult> asyncHandler)
AmazonConnectAsyncProvides 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.
listUserHierarchyGroupsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserProficienciesResult> listUserProficienciesAsync(ListUserProficienciesRequest request)
AmazonConnectAsyncLists proficiencies associated with a user.
listUserProficienciesAsync in interface AmazonConnectAsyncpublic Future<ListUserProficienciesResult> listUserProficienciesAsync(ListUserProficienciesRequest request, AsyncHandler<ListUserProficienciesRequest,ListUserProficienciesResult> asyncHandler)
AmazonConnectAsyncLists proficiencies associated with a user.
listUserProficienciesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AmazonConnectAsyncProvides summary information about the users for the specified Amazon Connect instance.
listUsersAsync in interface AmazonConnectAsyncpublic Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AmazonConnectAsyncProvides summary information about the users for the specified Amazon Connect instance.
listUsersAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListViewVersionsResult> listViewVersionsAsync(ListViewVersionsRequest request)
AmazonConnectAsyncReturns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersionsAsync in interface AmazonConnectAsyncpublic Future<ListViewVersionsResult> listViewVersionsAsync(ListViewVersionsRequest request, AsyncHandler<ListViewVersionsRequest,ListViewVersionsResult> asyncHandler)
AmazonConnectAsyncReturns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersionsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListViewsResult> listViewsAsync(ListViewsRequest request)
AmazonConnectAsyncReturns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViewsAsync in interface AmazonConnectAsyncpublic Future<ListViewsResult> listViewsAsync(ListViewsRequest request, AsyncHandler<ListViewsRequest,ListViewsResult> asyncHandler)
AmazonConnectAsyncReturns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViewsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<MonitorContactResult> monitorContactAsync(MonitorContactRequest request)
AmazonConnectAsyncInitiates 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.
monitorContactAsync in interface AmazonConnectAsyncpublic Future<MonitorContactResult> monitorContactAsync(MonitorContactRequest request, AsyncHandler<MonitorContactRequest,MonitorContactResult> asyncHandler)
AmazonConnectAsyncInitiates 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.
monitorContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PauseContactResult> pauseContactAsync(PauseContactRequest request)
AmazonConnectAsyncAllows pausing an ongoing task contact.
pauseContactAsync in interface AmazonConnectAsyncpublic Future<PauseContactResult> pauseContactAsync(PauseContactRequest request, AsyncHandler<PauseContactRequest,PauseContactResult> asyncHandler)
AmazonConnectAsyncAllows pausing an ongoing task contact.
pauseContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutUserStatusResult> putUserStatusAsync(PutUserStatusRequest request)
AmazonConnectAsyncChanges 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.
putUserStatusAsync in interface AmazonConnectAsyncpublic Future<PutUserStatusResult> putUserStatusAsync(PutUserStatusRequest request, AsyncHandler<PutUserStatusRequest,PutUserStatusResult> asyncHandler)
AmazonConnectAsyncChanges 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.
putUserStatusAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest request)
AmazonConnectAsyncReleases 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 admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.
releasePhoneNumberAsync in interface AmazonConnectAsyncpublic Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest request, AsyncHandler<ReleasePhoneNumberRequest,ReleasePhoneNumberResult> asyncHandler)
AmazonConnectAsyncReleases 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 admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.
releasePhoneNumberAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicateInstanceResult> replicateInstanceAsync(ReplicateInstanceRequest request)
AmazonConnectAsyncReplicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
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.
replicateInstanceAsync in interface AmazonConnectAsyncpublic Future<ReplicateInstanceResult> replicateInstanceAsync(ReplicateInstanceRequest request, AsyncHandler<ReplicateInstanceRequest,ReplicateInstanceResult> asyncHandler)
AmazonConnectAsyncReplicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
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.
replicateInstanceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResumeContactResult> resumeContactAsync(ResumeContactRequest request)
AmazonConnectAsyncAllows resuming a task contact in a paused state.
resumeContactAsync in interface AmazonConnectAsyncpublic Future<ResumeContactResult> resumeContactAsync(ResumeContactRequest request, AsyncHandler<ResumeContactRequest,ResumeContactResult> asyncHandler)
AmazonConnectAsyncAllows resuming a task contact in a paused state.
resumeContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResumeContactRecordingResult> resumeContactRecordingAsync(ResumeContactRecordingRequest request)
AmazonConnectAsyncWhen a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
resumeContactRecordingAsync in interface AmazonConnectAsyncpublic Future<ResumeContactRecordingResult> resumeContactRecordingAsync(ResumeContactRecordingRequest request, AsyncHandler<ResumeContactRecordingRequest,ResumeContactRecordingResult> asyncHandler)
AmazonConnectAsyncWhen a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
resumeContactRecordingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchAgentStatusesResult> searchAgentStatusesAsync(SearchAgentStatusesRequest request)
AmazonConnectAsyncSearches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatusesAsync in interface AmazonConnectAsyncpublic Future<SearchAgentStatusesResult> searchAgentStatusesAsync(SearchAgentStatusesRequest request, AsyncHandler<SearchAgentStatusesRequest,SearchAgentStatusesResult> asyncHandler)
AmazonConnectAsyncSearches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatusesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchAvailablePhoneNumbersResult> searchAvailablePhoneNumbersAsync(SearchAvailablePhoneNumbersRequest request)
AmazonConnectAsync
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.
searchAvailablePhoneNumbersAsync in interface AmazonConnectAsyncpublic Future<SearchAvailablePhoneNumbersResult> searchAvailablePhoneNumbersAsync(SearchAvailablePhoneNumbersRequest request, AsyncHandler<SearchAvailablePhoneNumbersRequest,SearchAvailablePhoneNumbersResult> asyncHandler)
AmazonConnectAsync
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.
searchAvailablePhoneNumbersAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchContactFlowModulesResult> searchContactFlowModulesAsync(SearchContactFlowModulesRequest request)
AmazonConnectAsyncSearches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModulesAsync in interface AmazonConnectAsyncpublic Future<SearchContactFlowModulesResult> searchContactFlowModulesAsync(SearchContactFlowModulesRequest request, AsyncHandler<SearchContactFlowModulesRequest,SearchContactFlowModulesResult> asyncHandler)
AmazonConnectAsyncSearches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModulesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchContactFlowsResult> searchContactFlowsAsync(SearchContactFlowsRequest request)
AmazonConnectAsyncSearches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlowsAsync in interface AmazonConnectAsyncpublic Future<SearchContactFlowsResult> searchContactFlowsAsync(SearchContactFlowsRequest request, AsyncHandler<SearchContactFlowsRequest,SearchContactFlowsResult> asyncHandler)
AmazonConnectAsyncSearches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlowsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchContactsResult> searchContactsAsync(SearchContactsRequest request)
AmazonConnectAsyncSearches contacts in an Amazon Connect instance.
searchContactsAsync in interface AmazonConnectAsyncpublic Future<SearchContactsResult> searchContactsAsync(SearchContactsRequest request, AsyncHandler<SearchContactsRequest,SearchContactsResult> asyncHandler)
AmazonConnectAsyncSearches contacts in an Amazon Connect instance.
searchContactsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchHoursOfOperationsResult> searchHoursOfOperationsAsync(SearchHoursOfOperationsRequest request)
AmazonConnectAsyncSearches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsAsync in interface AmazonConnectAsyncpublic Future<SearchHoursOfOperationsResult> searchHoursOfOperationsAsync(SearchHoursOfOperationsRequest request, AsyncHandler<SearchHoursOfOperationsRequest,SearchHoursOfOperationsResult> asyncHandler)
AmazonConnectAsyncSearches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchPredefinedAttributesResult> searchPredefinedAttributesAsync(SearchPredefinedAttributesRequest request)
AmazonConnectAsyncPredefined attributes that meet certain criteria.
searchPredefinedAttributesAsync in interface AmazonConnectAsyncpublic Future<SearchPredefinedAttributesResult> searchPredefinedAttributesAsync(SearchPredefinedAttributesRequest request, AsyncHandler<SearchPredefinedAttributesRequest,SearchPredefinedAttributesResult> asyncHandler)
AmazonConnectAsyncPredefined attributes that meet certain criteria.
searchPredefinedAttributesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchPromptsResult> searchPromptsAsync(SearchPromptsRequest request)
AmazonConnectAsyncSearches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsAsync in interface AmazonConnectAsyncpublic Future<SearchPromptsResult> searchPromptsAsync(SearchPromptsRequest request, AsyncHandler<SearchPromptsRequest,SearchPromptsResult> asyncHandler)
AmazonConnectAsyncSearches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchQueuesResult> searchQueuesAsync(SearchQueuesRequest request)
AmazonConnectAsyncSearches queues in an Amazon Connect instance, with optional filtering.
searchQueuesAsync in interface AmazonConnectAsyncpublic Future<SearchQueuesResult> searchQueuesAsync(SearchQueuesRequest request, AsyncHandler<SearchQueuesRequest,SearchQueuesResult> asyncHandler)
AmazonConnectAsyncSearches queues in an Amazon Connect instance, with optional filtering.
searchQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchQuickConnectsResult> searchQuickConnectsAsync(SearchQuickConnectsRequest request)
AmazonConnectAsyncSearches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsAsync in interface AmazonConnectAsyncpublic Future<SearchQuickConnectsResult> searchQuickConnectsAsync(SearchQuickConnectsRequest request, AsyncHandler<SearchQuickConnectsRequest,SearchQuickConnectsResult> asyncHandler)
AmazonConnectAsyncSearches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchResourceTagsResult> searchResourceTagsAsync(SearchResourceTagsRequest request)
AmazonConnectAsyncSearches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsAsync in interface AmazonConnectAsyncpublic Future<SearchResourceTagsResult> searchResourceTagsAsync(SearchResourceTagsRequest request, AsyncHandler<SearchResourceTagsRequest,SearchResourceTagsResult> asyncHandler)
AmazonConnectAsyncSearches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchRoutingProfilesResult> searchRoutingProfilesAsync(SearchRoutingProfilesRequest request)
AmazonConnectAsyncSearches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesAsync in interface AmazonConnectAsyncpublic Future<SearchRoutingProfilesResult> searchRoutingProfilesAsync(SearchRoutingProfilesRequest request, AsyncHandler<SearchRoutingProfilesRequest,SearchRoutingProfilesResult> asyncHandler)
AmazonConnectAsyncSearches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchSecurityProfilesResult> searchSecurityProfilesAsync(SearchSecurityProfilesRequest request)
AmazonConnectAsyncSearches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesAsync in interface AmazonConnectAsyncpublic Future<SearchSecurityProfilesResult> searchSecurityProfilesAsync(SearchSecurityProfilesRequest request, AsyncHandler<SearchSecurityProfilesRequest,SearchSecurityProfilesResult> asyncHandler)
AmazonConnectAsyncSearches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchUserHierarchyGroupsResult> searchUserHierarchyGroupsAsync(SearchUserHierarchyGroupsRequest request)
AmazonConnectAsyncSearches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an
instance. It is not user-definable, nor is it visible in the UI.
searchUserHierarchyGroupsAsync in interface AmazonConnectAsyncpublic Future<SearchUserHierarchyGroupsResult> searchUserHierarchyGroupsAsync(SearchUserHierarchyGroupsRequest request, AsyncHandler<SearchUserHierarchyGroupsRequest,SearchUserHierarchyGroupsResult> asyncHandler)
AmazonConnectAsyncSearches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an
instance. It is not user-definable, nor is it visible in the UI.
searchUserHierarchyGroupsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchUsersResult> searchUsersAsync(SearchUsersRequest request)
AmazonConnectAsyncSearches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersAsync in interface AmazonConnectAsyncpublic Future<SearchUsersResult> searchUsersAsync(SearchUsersRequest request, AsyncHandler<SearchUsersRequest,SearchUsersResult> asyncHandler)
AmazonConnectAsyncSearches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchVocabulariesResult> searchVocabulariesAsync(SearchVocabulariesRequest request)
AmazonConnectAsync
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabulariesAsync in interface AmazonConnectAsyncpublic Future<SearchVocabulariesResult> searchVocabulariesAsync(SearchVocabulariesRequest request, AsyncHandler<SearchVocabulariesRequest,SearchVocabulariesResult> asyncHandler)
AmazonConnectAsync
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabulariesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendChatIntegrationEventResult> sendChatIntegrationEventAsync(SendChatIntegrationEventRequest request)
AmazonConnectAsyncProcesses chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
sendChatIntegrationEventAsync in interface AmazonConnectAsyncpublic Future<SendChatIntegrationEventResult> sendChatIntegrationEventAsync(SendChatIntegrationEventRequest request, AsyncHandler<SendChatIntegrationEventRequest,SendChatIntegrationEventResult> asyncHandler)
AmazonConnectAsyncProcesses chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
sendChatIntegrationEventAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartAttachedFileUploadResult> startAttachedFileUploadAsync(StartAttachedFileUploadRequest request)
AmazonConnectAsyncProvides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
startAttachedFileUploadAsync in interface AmazonConnectAsyncpublic Future<StartAttachedFileUploadResult> startAttachedFileUploadAsync(StartAttachedFileUploadRequest request, AsyncHandler<StartAttachedFileUploadRequest,StartAttachedFileUploadResult> asyncHandler)
AmazonConnectAsyncProvides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
startAttachedFileUploadAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartChatContactResult> startChatContactAsync(StartChatContactRequest request)
AmazonConnectAsyncInitiates 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 the following topics in the Amazon Connect Administrator Guide:
startChatContactAsync in interface AmazonConnectAsyncpublic Future<StartChatContactResult> startChatContactAsync(StartChatContactRequest request, AsyncHandler<StartChatContactRequest,StartChatContactResult> asyncHandler)
AmazonConnectAsyncInitiates 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 the following topics in the Amazon Connect Administrator Guide:
startChatContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartContactEvaluationResult> startContactEvaluationAsync(StartContactEvaluationRequest request)
AmazonConnectAsyncStarts 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.
startContactEvaluationAsync in interface AmazonConnectAsyncpublic Future<StartContactEvaluationResult> startContactEvaluationAsync(StartContactEvaluationRequest request, AsyncHandler<StartContactEvaluationRequest,StartContactEvaluationResult> asyncHandler)
AmazonConnectAsyncStarts 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.
startContactEvaluationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartContactRecordingResult> startContactRecordingAsync(StartContactRecordingRequest request)
AmazonConnectAsyncStarts 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.
startContactRecordingAsync in interface AmazonConnectAsyncpublic Future<StartContactRecordingResult> startContactRecordingAsync(StartContactRecordingRequest request, AsyncHandler<StartContactRecordingRequest,StartContactRecordingResult> asyncHandler)
AmazonConnectAsyncStarts 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.
startContactRecordingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartContactStreamingResult> startContactStreamingAsync(StartContactStreamingRequest request)
AmazonConnectAsyncInitiates 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.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreamingAsync in interface AmazonConnectAsyncpublic Future<StartContactStreamingResult> startContactStreamingAsync(StartContactStreamingRequest request, AsyncHandler<StartContactStreamingRequest,StartContactStreamingResult> asyncHandler)
AmazonConnectAsyncInitiates 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.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreamingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request)
AmazonConnectAsync
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.
startOutboundVoiceContactAsync in interface AmazonConnectAsyncpublic Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest request, AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler)
AmazonConnectAsync
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.
startOutboundVoiceContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartTaskContactResult> startTaskContactAsync(StartTaskContactRequest request)
AmazonConnectAsyncInitiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share
the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID,
QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task
template has a flow configured to run it. If more than one parameter is specified, or only the
TaskTemplateID is specified but it does not have a flow configured, the request returns an error
because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota
or there are already 12 tasks referencing the same PreviousContactId. For more information about
service quotas for task contacts, see Amazon Connect
service quotas in the Amazon Connect Administrator Guide.
startTaskContactAsync in interface AmazonConnectAsyncpublic Future<StartTaskContactResult> startTaskContactAsync(StartTaskContactRequest request, AsyncHandler<StartTaskContactRequest,StartTaskContactResult> asyncHandler)
AmazonConnectAsyncInitiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share
the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID,
QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task
template has a flow configured to run it. If more than one parameter is specified, or only the
TaskTemplateID is specified but it does not have a flow configured, the request returns an error
because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota
or there are already 12 tasks referencing the same PreviousContactId. For more information about
service quotas for task contacts, see Amazon Connect
service quotas in the Amazon Connect Administrator Guide.
startTaskContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartWebRTCContactResult> startWebRTCContactAsync(StartWebRTCContactRequest request)
AmazonConnectAsyncPlaces an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
startWebRTCContactAsync in interface AmazonConnectAsyncpublic Future<StartWebRTCContactResult> startWebRTCContactAsync(StartWebRTCContactRequest request, AsyncHandler<StartWebRTCContactRequest,StartWebRTCContactResult> asyncHandler)
AmazonConnectAsyncPlaces an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
startWebRTCContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopContactResult> stopContactAsync(StopContactRequest request)
AmazonConnectAsyncEnds the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
stopContactAsync in interface AmazonConnectAsyncpublic Future<StopContactResult> stopContactAsync(StopContactRequest request, AsyncHandler<StopContactRequest,StopContactResult> asyncHandler)
AmazonConnectAsyncEnds the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
stopContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopContactRecordingResult> stopContactRecordingAsync(StopContactRecordingRequest request)
AmazonConnectAsyncStops 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.
stopContactRecordingAsync in interface AmazonConnectAsyncpublic Future<StopContactRecordingResult> stopContactRecordingAsync(StopContactRecordingRequest request, AsyncHandler<StopContactRecordingRequest,StopContactRecordingResult> asyncHandler)
AmazonConnectAsyncStops 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.
stopContactRecordingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopContactStreamingResult> stopContactStreamingAsync(StopContactStreamingRequest request)
AmazonConnectAsyncEnds message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingAsync in interface AmazonConnectAsyncpublic Future<StopContactStreamingResult> stopContactStreamingAsync(StopContactStreamingRequest request, AsyncHandler<StopContactStreamingRequest,StopContactStreamingResult> asyncHandler)
AmazonConnectAsyncEnds message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitContactEvaluationResult> submitContactEvaluationAsync(SubmitContactEvaluationRequest request)
AmazonConnectAsync
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.
submitContactEvaluationAsync in interface AmazonConnectAsyncpublic Future<SubmitContactEvaluationResult> submitContactEvaluationAsync(SubmitContactEvaluationRequest request, AsyncHandler<SubmitContactEvaluationRequest,SubmitContactEvaluationResult> asyncHandler)
AmazonConnectAsync
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.
submitContactEvaluationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SuspendContactRecordingResult> suspendContactRecordingAsync(SuspendContactRecordingRequest request)
AmazonConnectAsyncWhen a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
suspendContactRecordingAsync in interface AmazonConnectAsyncpublic Future<SuspendContactRecordingResult> suspendContactRecordingAsync(SuspendContactRecordingRequest request, AsyncHandler<SuspendContactRecordingRequest,SuspendContactRecordingResult> asyncHandler)
AmazonConnectAsyncWhen a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
suspendContactRecordingAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagContactResult> tagContactAsync(TagContactRequest request)
AmazonConnectAsyncAdds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
tagContactAsync in interface AmazonConnectAsyncpublic Future<TagContactResult> tagContactAsync(TagContactRequest request, AsyncHandler<TagContactRequest,TagContactResult> asyncHandler)
AmazonConnectAsyncAdds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
tagContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonConnectAsyncAdds 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.
tagResourceAsync in interface AmazonConnectAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonConnectAsyncAdds 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.
tagResourceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TransferContactResult> transferContactAsync(TransferContactRequest request)
AmazonConnectAsyncTransfers 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.
transferContactAsync in interface AmazonConnectAsyncpublic Future<TransferContactResult> transferContactAsync(TransferContactRequest request, AsyncHandler<TransferContactRequest,TransferContactResult> asyncHandler)
AmazonConnectAsyncTransfers 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.
transferContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagContactResult> untagContactAsync(UntagContactRequest request)
AmazonConnectAsyncRemoves the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
untagContactAsync in interface AmazonConnectAsyncpublic Future<UntagContactResult> untagContactAsync(UntagContactRequest request, AsyncHandler<UntagContactRequest,UntagContactResult> asyncHandler)
AmazonConnectAsyncRemoves the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
untagContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonConnectAsyncRemoves the specified tags from the specified resource.
untagResourceAsync in interface AmazonConnectAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonConnectAsyncRemoves the specified tags from the specified resource.
untagResourceAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAgentStatusResult> updateAgentStatusAsync(UpdateAgentStatusRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusAsync in interface AmazonConnectAsyncpublic Future<UpdateAgentStatusResult> updateAgentStatusAsync(UpdateAgentStatusRequest request, AsyncHandler<UpdateAgentStatusRequest,UpdateAgentStatusResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAuthenticationProfileResult> updateAuthenticationProfileAsync(UpdateAuthenticationProfileRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
updateAuthenticationProfileAsync in interface AmazonConnectAsyncpublic Future<UpdateAuthenticationProfileResult> updateAuthenticationProfileAsync(UpdateAuthenticationProfileRequest request, AsyncHandler<UpdateAuthenticationProfileRequest,UpdateAuthenticationProfileResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
updateAuthenticationProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactResult> updateContactAsync(UpdateContactRequest request)
AmazonConnectAsyncThis 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.
updateContactAsync in interface AmazonConnectAsyncpublic Future<UpdateContactResult> updateContactAsync(UpdateContactRequest request, AsyncHandler<UpdateContactRequest,UpdateContactResult> asyncHandler)
AmazonConnectAsyncThis 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.
updateContactAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest request)
AmazonConnectAsyncCreates 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.
updateContactAttributesAsync in interface AmazonConnectAsyncpublic Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest request, AsyncHandler<UpdateContactAttributesRequest,UpdateContactAttributesResult> asyncHandler)
AmazonConnectAsyncCreates 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.
updateContactAttributesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactEvaluationResult> updateContactEvaluationAsync(UpdateContactEvaluationRequest request)
AmazonConnectAsync
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.
updateContactEvaluationAsync in interface AmazonConnectAsyncpublic Future<UpdateContactEvaluationResult> updateContactEvaluationAsync(UpdateContactEvaluationRequest request, AsyncHandler<UpdateContactEvaluationRequest,UpdateContactEvaluationResult> asyncHandler)
AmazonConnectAsync
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.
updateContactEvaluationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactFlowContentResult> updateContactFlowContentAsync(UpdateContactFlowContentRequest request)
AmazonConnectAsyncUpdates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowContentAsync in interface AmazonConnectAsyncpublic Future<UpdateContactFlowContentResult> updateContactFlowContentAsync(UpdateContactFlowContentRequest request, AsyncHandler<UpdateContactFlowContentRequest,UpdateContactFlowContentResult> asyncHandler)
AmazonConnectAsyncUpdates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowContentAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactFlowMetadataResult> updateContactFlowMetadataAsync(UpdateContactFlowMetadataRequest request)
AmazonConnectAsyncUpdates metadata about specified flow.
updateContactFlowMetadataAsync in interface AmazonConnectAsyncpublic Future<UpdateContactFlowMetadataResult> updateContactFlowMetadataAsync(UpdateContactFlowMetadataRequest request, AsyncHandler<UpdateContactFlowMetadataRequest,UpdateContactFlowMetadataResult> asyncHandler)
AmazonConnectAsyncUpdates metadata about specified flow.
updateContactFlowMetadataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactFlowModuleContentResult> updateContactFlowModuleContentAsync(UpdateContactFlowModuleContentRequest request)
AmazonConnectAsyncUpdates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowModuleContentAsync in interface AmazonConnectAsyncpublic Future<UpdateContactFlowModuleContentResult> updateContactFlowModuleContentAsync(UpdateContactFlowModuleContentRequest request, AsyncHandler<UpdateContactFlowModuleContentRequest,UpdateContactFlowModuleContentResult> asyncHandler)
AmazonConnectAsyncUpdates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowModuleContentAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactFlowModuleMetadataResult> updateContactFlowModuleMetadataAsync(UpdateContactFlowModuleMetadataRequest request)
AmazonConnectAsyncUpdates metadata about specified flow module.
updateContactFlowModuleMetadataAsync in interface AmazonConnectAsyncpublic Future<UpdateContactFlowModuleMetadataResult> updateContactFlowModuleMetadataAsync(UpdateContactFlowModuleMetadataRequest request, AsyncHandler<UpdateContactFlowModuleMetadataRequest,UpdateContactFlowModuleMetadataResult> asyncHandler)
AmazonConnectAsyncUpdates metadata about specified flow module.
updateContactFlowModuleMetadataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactFlowNameResult> updateContactFlowNameAsync(UpdateContactFlowNameRequest request)
AmazonConnectAsyncThe name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameAsync in interface AmazonConnectAsyncpublic Future<UpdateContactFlowNameResult> updateContactFlowNameAsync(UpdateContactFlowNameRequest request, AsyncHandler<UpdateContactFlowNameRequest,UpdateContactFlowNameResult> asyncHandler)
AmazonConnectAsyncThe name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactRoutingDataResult> updateContactRoutingDataAsync(UpdateContactRoutingDataRequest request)
AmazonConnectAsyncUpdates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
updateContactRoutingDataAsync in interface AmazonConnectAsyncpublic Future<UpdateContactRoutingDataResult> updateContactRoutingDataAsync(UpdateContactRoutingDataRequest request, AsyncHandler<UpdateContactRoutingDataRequest,UpdateContactRoutingDataResult> asyncHandler)
AmazonConnectAsyncUpdates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
updateContactRoutingDataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContactScheduleResult> updateContactScheduleAsync(UpdateContactScheduleRequest request)
AmazonConnectAsyncUpdates the scheduled time of a task contact that is already scheduled.
updateContactScheduleAsync in interface AmazonConnectAsyncpublic Future<UpdateContactScheduleResult> updateContactScheduleAsync(UpdateContactScheduleRequest request, AsyncHandler<UpdateContactScheduleRequest,UpdateContactScheduleResult> asyncHandler)
AmazonConnectAsyncUpdates the scheduled time of a task contact that is already scheduled.
updateContactScheduleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateEvaluationFormResult> updateEvaluationFormAsync(UpdateEvaluationFormRequest request)
AmazonConnectAsyncUpdates 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.
updateEvaluationFormAsync in interface AmazonConnectAsyncpublic Future<UpdateEvaluationFormResult> updateEvaluationFormAsync(UpdateEvaluationFormRequest request, AsyncHandler<UpdateEvaluationFormRequest,UpdateEvaluationFormResult> asyncHandler)
AmazonConnectAsyncUpdates 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.
updateEvaluationFormAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateHoursOfOperationResult> updateHoursOfOperationAsync(UpdateHoursOfOperationRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationAsync in interface AmazonConnectAsyncpublic Future<UpdateHoursOfOperationResult> updateHoursOfOperationAsync(UpdateHoursOfOperationRequest request, AsyncHandler<UpdateHoursOfOperationRequest,UpdateHoursOfOperationResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateInstanceAttributeResult> updateInstanceAttributeAsync(UpdateInstanceAttributeRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeAsync in interface AmazonConnectAsyncpublic Future<UpdateInstanceAttributeResult> updateInstanceAttributeAsync(UpdateInstanceAttributeRequest request, AsyncHandler<UpdateInstanceAttributeRequest,UpdateInstanceAttributeResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateInstanceStorageConfigResult> updateInstanceStorageConfigAsync(UpdateInstanceStorageConfigRequest request)
AmazonConnectAsyncThis 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.
updateInstanceStorageConfigAsync in interface AmazonConnectAsyncpublic Future<UpdateInstanceStorageConfigResult> updateInstanceStorageConfigAsync(UpdateInstanceStorageConfigRequest request, AsyncHandler<UpdateInstanceStorageConfigRequest,UpdateInstanceStorageConfigResult> asyncHandler)
AmazonConnectAsyncThis 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.
updateInstanceStorageConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateParticipantRoleConfigResult> updateParticipantRoleConfigAsync(UpdateParticipantRoleConfigRequest request)
AmazonConnectAsyncUpdates 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.
updateParticipantRoleConfigAsync in interface AmazonConnectAsyncpublic Future<UpdateParticipantRoleConfigResult> updateParticipantRoleConfigAsync(UpdateParticipantRoleConfigRequest request, AsyncHandler<UpdateParticipantRoleConfigRequest,UpdateParticipantRoleConfigResult> asyncHandler)
AmazonConnectAsyncUpdates 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.
updateParticipantRoleConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest request)
AmazonConnectAsyncUpdates 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.
updatePhoneNumberAsync in interface AmazonConnectAsyncpublic Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest request, AsyncHandler<UpdatePhoneNumberRequest,UpdatePhoneNumberResult> asyncHandler)
AmazonConnectAsyncUpdates 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.
updatePhoneNumberAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePhoneNumberMetadataResult> updatePhoneNumberMetadataAsync(UpdatePhoneNumberMetadataRequest request)
AmazonConnectAsyncUpdates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadataAsync in interface AmazonConnectAsyncpublic Future<UpdatePhoneNumberMetadataResult> updatePhoneNumberMetadataAsync(UpdatePhoneNumberMetadataRequest request, AsyncHandler<UpdatePhoneNumberMetadataRequest,UpdatePhoneNumberMetadataResult> asyncHandler)
AmazonConnectAsyncUpdates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePredefinedAttributeResult> updatePredefinedAttributeAsync(UpdatePredefinedAttributeRequest request)
AmazonConnectAsyncUpdates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttributeAsync in interface AmazonConnectAsyncpublic Future<UpdatePredefinedAttributeResult> updatePredefinedAttributeAsync(UpdatePredefinedAttributeRequest request, AsyncHandler<UpdatePredefinedAttributeRequest,UpdatePredefinedAttributeResult> asyncHandler)
AmazonConnectAsyncUpdates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttributeAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePromptResult> updatePromptAsync(UpdatePromptRequest request)
AmazonConnectAsyncUpdates a prompt.
updatePromptAsync in interface AmazonConnectAsyncpublic Future<UpdatePromptResult> updatePromptAsync(UpdatePromptRequest request, AsyncHandler<UpdatePromptRequest,UpdatePromptResult> asyncHandler)
AmazonConnectAsyncUpdates a prompt.
updatePromptAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQueueHoursOfOperationResult> updateQueueHoursOfOperationAsync(UpdateQueueHoursOfOperationRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationAsync in interface AmazonConnectAsyncpublic Future<UpdateQueueHoursOfOperationResult> updateQueueHoursOfOperationAsync(UpdateQueueHoursOfOperationRequest request, AsyncHandler<UpdateQueueHoursOfOperationRequest,UpdateQueueHoursOfOperationResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQueueMaxContactsResult> updateQueueMaxContactsAsync(UpdateQueueMaxContactsRequest request)
AmazonConnectAsyncThis 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.
updateQueueMaxContactsAsync in interface AmazonConnectAsyncpublic Future<UpdateQueueMaxContactsResult> updateQueueMaxContactsAsync(UpdateQueueMaxContactsRequest request, AsyncHandler<UpdateQueueMaxContactsRequest,UpdateQueueMaxContactsResult> asyncHandler)
AmazonConnectAsyncThis 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.
updateQueueMaxContactsAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQueueNameResult> updateQueueNameAsync(UpdateQueueNameRequest request)
AmazonConnectAsyncThis 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.
updateQueueNameAsync in interface AmazonConnectAsyncpublic Future<UpdateQueueNameResult> updateQueueNameAsync(UpdateQueueNameRequest request, AsyncHandler<UpdateQueueNameRequest,UpdateQueueNameResult> asyncHandler)
AmazonConnectAsyncThis 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.
updateQueueNameAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQueueOutboundCallerConfigResult> updateQueueOutboundCallerConfigAsync(UpdateQueueOutboundCallerConfigRequest request)
AmazonConnectAsyncThis 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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is 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.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
updateQueueOutboundCallerConfigAsync in interface AmazonConnectAsyncpublic Future<UpdateQueueOutboundCallerConfigResult> updateQueueOutboundCallerConfigAsync(UpdateQueueOutboundCallerConfigRequest request, AsyncHandler<UpdateQueueOutboundCallerConfigRequest,UpdateQueueOutboundCallerConfigResult> asyncHandler)
AmazonConnectAsyncThis 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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is 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.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
updateQueueOutboundCallerConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQueueStatusResult> updateQueueStatusAsync(UpdateQueueStatusRequest request)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusAsync in interface AmazonConnectAsyncpublic Future<UpdateQueueStatusResult> updateQueueStatusAsync(UpdateQueueStatusRequest request, AsyncHandler<UpdateQueueStatusRequest,UpdateQueueStatusResult> asyncHandler)
AmazonConnectAsyncThis API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQuickConnectConfigResult> updateQuickConnectConfigAsync(UpdateQuickConnectConfigRequest request)
AmazonConnectAsyncUpdates the configuration settings for the specified quick connect.
updateQuickConnectConfigAsync in interface AmazonConnectAsyncpublic Future<UpdateQuickConnectConfigResult> updateQuickConnectConfigAsync(UpdateQuickConnectConfigRequest request, AsyncHandler<UpdateQuickConnectConfigRequest,UpdateQuickConnectConfigResult> asyncHandler)
AmazonConnectAsyncUpdates the configuration settings for the specified quick connect.
updateQuickConnectConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQuickConnectNameResult> updateQuickConnectNameAsync(UpdateQuickConnectNameRequest request)
AmazonConnectAsync
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.
updateQuickConnectNameAsync in interface AmazonConnectAsyncpublic Future<UpdateQuickConnectNameResult> updateQuickConnectNameAsync(UpdateQuickConnectNameRequest request, AsyncHandler<UpdateQuickConnectNameRequest,UpdateQuickConnectNameResult> asyncHandler)
AmazonConnectAsync
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.
updateQuickConnectNameAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoutingProfileAgentAvailabilityTimerResult> updateRoutingProfileAgentAvailabilityTimerAsync(UpdateRoutingProfileAgentAvailabilityTimerRequest request)
AmazonConnectAsyncWhether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerAsync in interface AmazonConnectAsyncpublic Future<UpdateRoutingProfileAgentAvailabilityTimerResult> updateRoutingProfileAgentAvailabilityTimerAsync(UpdateRoutingProfileAgentAvailabilityTimerRequest request, AsyncHandler<UpdateRoutingProfileAgentAvailabilityTimerRequest,UpdateRoutingProfileAgentAvailabilityTimerResult> asyncHandler)
AmazonConnectAsyncWhether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoutingProfileConcurrencyResult> updateRoutingProfileConcurrencyAsync(UpdateRoutingProfileConcurrencyRequest request)
AmazonConnectAsyncUpdates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyAsync in interface AmazonConnectAsyncpublic Future<UpdateRoutingProfileConcurrencyResult> updateRoutingProfileConcurrencyAsync(UpdateRoutingProfileConcurrencyRequest request, AsyncHandler<UpdateRoutingProfileConcurrencyRequest,UpdateRoutingProfileConcurrencyResult> asyncHandler)
AmazonConnectAsyncUpdates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoutingProfileDefaultOutboundQueueResult> updateRoutingProfileDefaultOutboundQueueAsync(UpdateRoutingProfileDefaultOutboundQueueRequest request)
AmazonConnectAsyncUpdates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueAsync in interface AmazonConnectAsyncpublic Future<UpdateRoutingProfileDefaultOutboundQueueResult> updateRoutingProfileDefaultOutboundQueueAsync(UpdateRoutingProfileDefaultOutboundQueueRequest request, AsyncHandler<UpdateRoutingProfileDefaultOutboundQueueRequest,UpdateRoutingProfileDefaultOutboundQueueResult> asyncHandler)
AmazonConnectAsyncUpdates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoutingProfileNameResult> updateRoutingProfileNameAsync(UpdateRoutingProfileNameRequest request)
AmazonConnectAsync
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.
updateRoutingProfileNameAsync in interface AmazonConnectAsyncpublic Future<UpdateRoutingProfileNameResult> updateRoutingProfileNameAsync(UpdateRoutingProfileNameRequest request, AsyncHandler<UpdateRoutingProfileNameRequest,UpdateRoutingProfileNameResult> asyncHandler)
AmazonConnectAsync
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.
updateRoutingProfileNameAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRoutingProfileQueuesResult> updateRoutingProfileQueuesAsync(UpdateRoutingProfileQueuesRequest request)
AmazonConnectAsyncUpdates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesAsync in interface AmazonConnectAsyncpublic Future<UpdateRoutingProfileQueuesResult> updateRoutingProfileQueuesAsync(UpdateRoutingProfileQueuesRequest request, AsyncHandler<UpdateRoutingProfileQueuesRequest,UpdateRoutingProfileQueuesResult> asyncHandler)
AmazonConnectAsyncUpdates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest request)
AmazonConnectAsyncUpdates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleAsync in interface AmazonConnectAsyncpublic Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest request, AsyncHandler<UpdateRuleRequest,UpdateRuleResult> asyncHandler)
AmazonConnectAsyncUpdates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateSecurityProfileResult> updateSecurityProfileAsync(UpdateSecurityProfileRequest request)
AmazonConnectAsyncUpdates a security profile.
updateSecurityProfileAsync in interface AmazonConnectAsyncpublic Future<UpdateSecurityProfileResult> updateSecurityProfileAsync(UpdateSecurityProfileRequest request, AsyncHandler<UpdateSecurityProfileRequest,UpdateSecurityProfileResult> asyncHandler)
AmazonConnectAsyncUpdates a security profile.
updateSecurityProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTaskTemplateResult> updateTaskTemplateAsync(UpdateTaskTemplateRequest request)
AmazonConnectAsyncUpdates 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.
updateTaskTemplateAsync in interface AmazonConnectAsyncpublic Future<UpdateTaskTemplateResult> updateTaskTemplateAsync(UpdateTaskTemplateRequest request, AsyncHandler<UpdateTaskTemplateRequest,UpdateTaskTemplateResult> asyncHandler)
AmazonConnectAsyncUpdates 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.
updateTaskTemplateAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTrafficDistributionResult> updateTrafficDistributionAsync(UpdateTrafficDistributionRequest request)
AmazonConnectAsyncUpdates the traffic distribution for a given traffic distribution group.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). 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.
updateTrafficDistributionAsync in interface AmazonConnectAsyncpublic Future<UpdateTrafficDistributionResult> updateTrafficDistributionAsync(UpdateTrafficDistributionRequest request, AsyncHandler<UpdateTrafficDistributionRequest,UpdateTrafficDistributionResult> asyncHandler)
AmazonConnectAsyncUpdates the traffic distribution for a given traffic distribution group.
The SignInConfig distribution is available only on a default TrafficDistributionGroup
(see the IsDefault parameter in the TrafficDistributionGroup data type). 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.
updateTrafficDistributionAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest request)
AmazonConnectAsyncAssigns the specified hierarchy group to the specified user.
updateUserHierarchyAsync in interface AmazonConnectAsyncpublic Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest request, AsyncHandler<UpdateUserHierarchyRequest,UpdateUserHierarchyResult> asyncHandler)
AmazonConnectAsyncAssigns the specified hierarchy group to the specified user.
updateUserHierarchyAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserHierarchyGroupNameResult> updateUserHierarchyGroupNameAsync(UpdateUserHierarchyGroupNameRequest request)
AmazonConnectAsyncUpdates the name of the user hierarchy group.
updateUserHierarchyGroupNameAsync in interface AmazonConnectAsyncpublic Future<UpdateUserHierarchyGroupNameResult> updateUserHierarchyGroupNameAsync(UpdateUserHierarchyGroupNameRequest request, AsyncHandler<UpdateUserHierarchyGroupNameRequest,UpdateUserHierarchyGroupNameResult> asyncHandler)
AmazonConnectAsyncUpdates the name of the user hierarchy group.
updateUserHierarchyGroupNameAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserHierarchyStructureResult> updateUserHierarchyStructureAsync(UpdateUserHierarchyStructureRequest request)
AmazonConnectAsyncUpdates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureAsync in interface AmazonConnectAsyncpublic Future<UpdateUserHierarchyStructureResult> updateUserHierarchyStructureAsync(UpdateUserHierarchyStructureRequest request, AsyncHandler<UpdateUserHierarchyStructureRequest,UpdateUserHierarchyStructureResult> asyncHandler)
AmazonConnectAsyncUpdates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest request)
AmazonConnectAsyncUpdates 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.
updateUserIdentityInfoAsync in interface AmazonConnectAsyncpublic Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest request, AsyncHandler<UpdateUserIdentityInfoRequest,UpdateUserIdentityInfoResult> asyncHandler)
AmazonConnectAsyncUpdates 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.
updateUserIdentityInfoAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest request)
AmazonConnectAsyncUpdates the phone configuration settings for the specified user.
updateUserPhoneConfigAsync in interface AmazonConnectAsyncpublic Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest request, AsyncHandler<UpdateUserPhoneConfigRequest,UpdateUserPhoneConfigResult> asyncHandler)
AmazonConnectAsyncUpdates the phone configuration settings for the specified user.
updateUserPhoneConfigAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserProficienciesResult> updateUserProficienciesAsync(UpdateUserProficienciesRequest request)
AmazonConnectAsyncUpdates the properties associated with the proficiencies of a user.
updateUserProficienciesAsync in interface AmazonConnectAsyncpublic Future<UpdateUserProficienciesResult> updateUserProficienciesAsync(UpdateUserProficienciesRequest request, AsyncHandler<UpdateUserProficienciesRequest,UpdateUserProficienciesResult> asyncHandler)
AmazonConnectAsyncUpdates the properties associated with the proficiencies of a user.
updateUserProficienciesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest request)
AmazonConnectAsyncAssigns the specified routing profile to the specified user.
updateUserRoutingProfileAsync in interface AmazonConnectAsyncpublic Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest request, AsyncHandler<UpdateUserRoutingProfileRequest,UpdateUserRoutingProfileResult> asyncHandler)
AmazonConnectAsyncAssigns the specified routing profile to the specified user.
updateUserRoutingProfileAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest request)
AmazonConnectAsyncAssigns the specified security profiles to the specified user.
updateUserSecurityProfilesAsync in interface AmazonConnectAsyncpublic Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest request, AsyncHandler<UpdateUserSecurityProfilesRequest,UpdateUserSecurityProfilesResult> asyncHandler)
AmazonConnectAsyncAssigns the specified security profiles to the specified user.
updateUserSecurityProfilesAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateViewContentResult> updateViewContentAsync(UpdateViewContentRequest request)
AmazonConnectAsyncUpdates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status is set to SAVED and performs full content
validation if Status is PUBLISHED. Note that the $SAVED alias' content
will always be updated, but the $LATEST alias' content will only be updated if Status
is PUBLISHED.
updateViewContentAsync in interface AmazonConnectAsyncpublic Future<UpdateViewContentResult> updateViewContentAsync(UpdateViewContentRequest request, AsyncHandler<UpdateViewContentRequest,UpdateViewContentResult> asyncHandler)
AmazonConnectAsyncUpdates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status is set to SAVED and performs full content
validation if Status is PUBLISHED. Note that the $SAVED alias' content
will always be updated, but the $LATEST alias' content will only be updated if Status
is PUBLISHED.
updateViewContentAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateViewMetadataResult> updateViewMetadataAsync(UpdateViewMetadataRequest request)
AmazonConnectAsync
Updates the view metadata. Note that either Name or Description must be provided.
updateViewMetadataAsync in interface AmazonConnectAsyncpublic Future<UpdateViewMetadataResult> updateViewMetadataAsync(UpdateViewMetadataRequest request, AsyncHandler<UpdateViewMetadataRequest,UpdateViewMetadataResult> asyncHandler)
AmazonConnectAsync
Updates the view metadata. Note that either Name or Description must be provided.
updateViewMetadataAsync in interface AmazonConnectAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonConnectshutdown in class AmazonConnectClientCopyright © 2024. All rights reserved.