@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectAsync extends AmazonConnect
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnectAsync instead.
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.
ENDPOINT_PREFIXactivateEvaluationForm, 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, shutdown, 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, updateViewMetadataFuture<ActivateEvaluationFormResult> activateEvaluationFormAsync(ActivateEvaluationFormRequest activateEvaluationFormRequest)
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
activateEvaluationFormRequest - Future<ActivateEvaluationFormResult> activateEvaluationFormAsync(ActivateEvaluationFormRequest activateEvaluationFormRequest, AsyncHandler<ActivateEvaluationFormRequest,ActivateEvaluationFormResult> asyncHandler)
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
activateEvaluationFormRequest - 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.Future<AssociateAnalyticsDataSetResult> associateAnalyticsDataSetAsync(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest)
This 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.
associateAnalyticsDataSetRequest - Future<AssociateAnalyticsDataSetResult> associateAnalyticsDataSetAsync(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest, AsyncHandler<AssociateAnalyticsDataSetRequest,AssociateAnalyticsDataSetResult> asyncHandler)
This 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.
associateAnalyticsDataSetRequest - 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.Future<AssociateApprovedOriginResult> associateApprovedOriginAsync(AssociateApprovedOriginRequest associateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginRequest - Future<AssociateApprovedOriginResult> associateApprovedOriginAsync(AssociateApprovedOriginRequest associateApprovedOriginRequest, AsyncHandler<AssociateApprovedOriginRequest,AssociateApprovedOriginResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginRequest - 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.Future<AssociateBotResult> associateBotAsync(AssociateBotRequest associateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
associateBotRequest - Future<AssociateBotResult> associateBotAsync(AssociateBotRequest associateBotRequest, AsyncHandler<AssociateBotRequest,AssociateBotResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
associateBotRequest - 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.Future<AssociateDefaultVocabularyResult> associateDefaultVocabularyAsync(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
associateDefaultVocabularyRequest - Future<AssociateDefaultVocabularyResult> associateDefaultVocabularyAsync(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest, AsyncHandler<AssociateDefaultVocabularyRequest,AssociateDefaultVocabularyResult> asyncHandler)
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
associateDefaultVocabularyRequest - 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.Future<AssociateFlowResult> associateFlowAsync(AssociateFlowRequest associateFlowRequest)
Associates a connect resource to a flow.
associateFlowRequest - Future<AssociateFlowResult> associateFlowAsync(AssociateFlowRequest associateFlowRequest, AsyncHandler<AssociateFlowRequest,AssociateFlowResult> asyncHandler)
Associates a connect resource to a flow.
associateFlowRequest - 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.Future<AssociateInstanceStorageConfigResult> associateInstanceStorageConfigAsync(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
associateInstanceStorageConfigRequest - Future<AssociateInstanceStorageConfigResult> associateInstanceStorageConfigAsync(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest, AsyncHandler<AssociateInstanceStorageConfigRequest,AssociateInstanceStorageConfigResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
associateInstanceStorageConfigRequest - 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.Future<AssociateLambdaFunctionResult> associateLambdaFunctionAsync(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunctionRequest - Future<AssociateLambdaFunctionResult> associateLambdaFunctionAsync(AssociateLambdaFunctionRequest associateLambdaFunctionRequest, AsyncHandler<AssociateLambdaFunctionRequest,AssociateLambdaFunctionResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunctionRequest - 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.Future<AssociateLexBotResult> associateLexBotAsync(AssociateLexBotRequest associateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
associateLexBotRequest - Future<AssociateLexBotResult> associateLexBotAsync(AssociateLexBotRequest associateLexBotRequest, AsyncHandler<AssociateLexBotRequest,AssociateLexBotResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
associateLexBotRequest - 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.Future<AssociatePhoneNumberContactFlowResult> associatePhoneNumberContactFlowAsync(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
associatePhoneNumberContactFlowRequest - Future<AssociatePhoneNumberContactFlowResult> associatePhoneNumberContactFlowAsync(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest, AsyncHandler<AssociatePhoneNumberContactFlowRequest,AssociatePhoneNumberContactFlowResult> asyncHandler)
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
associatePhoneNumberContactFlowRequest - 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.Future<AssociateQueueQuickConnectsResult> associateQueueQuickConnectsAsync(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsRequest - Future<AssociateQueueQuickConnectsResult> associateQueueQuickConnectsAsync(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest, AsyncHandler<AssociateQueueQuickConnectsRequest,AssociateQueueQuickConnectsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnectsRequest - 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.Future<AssociateRoutingProfileQueuesResult> associateRoutingProfileQueuesAsync(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
Associates a set of queues with a routing profile.
associateRoutingProfileQueuesRequest - Future<AssociateRoutingProfileQueuesResult> associateRoutingProfileQueuesAsync(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest, AsyncHandler<AssociateRoutingProfileQueuesRequest,AssociateRoutingProfileQueuesResult> asyncHandler)
Associates a set of queues with a routing profile.
associateRoutingProfileQueuesRequest - 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.Future<AssociateSecurityKeyResult> associateSecurityKeyAsync(AssociateSecurityKeyRequest associateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyRequest - Future<AssociateSecurityKeyResult> associateSecurityKeyAsync(AssociateSecurityKeyRequest associateSecurityKeyRequest, AsyncHandler<AssociateSecurityKeyRequest,AssociateSecurityKeyResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyRequest - 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.Future<AssociateTrafficDistributionGroupUserResult> associateTrafficDistributionGroupUserAsync(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserRequest - Future<AssociateTrafficDistributionGroupUserResult> associateTrafficDistributionGroupUserAsync(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest, AsyncHandler<AssociateTrafficDistributionGroupUserRequest,AssociateTrafficDistributionGroupUserResult> asyncHandler)
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUserRequest - 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.Future<AssociateUserProficienciesResult> associateUserProficienciesAsync(AssociateUserProficienciesRequest associateUserProficienciesRequest)
>Associates a set of proficiencies with a user.
associateUserProficienciesRequest - Future<AssociateUserProficienciesResult> associateUserProficienciesAsync(AssociateUserProficienciesRequest associateUserProficienciesRequest, AsyncHandler<AssociateUserProficienciesRequest,AssociateUserProficienciesResult> asyncHandler)
>Associates a set of proficiencies with a user.
associateUserProficienciesRequest - 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.Future<BatchAssociateAnalyticsDataSetResult> batchAssociateAnalyticsDataSetAsync(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest)
This 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.
batchAssociateAnalyticsDataSetRequest - Future<BatchAssociateAnalyticsDataSetResult> batchAssociateAnalyticsDataSetAsync(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest, AsyncHandler<BatchAssociateAnalyticsDataSetRequest,BatchAssociateAnalyticsDataSetResult> asyncHandler)
This 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.
batchAssociateAnalyticsDataSetRequest - 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.Future<BatchDisassociateAnalyticsDataSetResult> batchDisassociateAnalyticsDataSetAsync(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest)
This 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.
batchDisassociateAnalyticsDataSetRequest - Future<BatchDisassociateAnalyticsDataSetResult> batchDisassociateAnalyticsDataSetAsync(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest, AsyncHandler<BatchDisassociateAnalyticsDataSetRequest,BatchDisassociateAnalyticsDataSetResult> asyncHandler)
This 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.
batchDisassociateAnalyticsDataSetRequest - 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.Future<BatchGetAttachedFileMetadataResult> batchGetAttachedFileMetadataAsync(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest)
Allows 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.
batchGetAttachedFileMetadataRequest - Future<BatchGetAttachedFileMetadataResult> batchGetAttachedFileMetadataAsync(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest, AsyncHandler<BatchGetAttachedFileMetadataRequest,BatchGetAttachedFileMetadataResult> asyncHandler)
Allows 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.
batchGetAttachedFileMetadataRequest - 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.Future<BatchGetFlowAssociationResult> batchGetFlowAssociationAsync(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest)
Retrieve the flow associations for the given resources.
batchGetFlowAssociationRequest - Future<BatchGetFlowAssociationResult> batchGetFlowAssociationAsync(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest, AsyncHandler<BatchGetFlowAssociationRequest,BatchGetFlowAssociationResult> asyncHandler)
Retrieve the flow associations for the given resources.
batchGetFlowAssociationRequest - 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.Future<BatchPutContactResult> batchPutContactAsync(BatchPutContactRequest batchPutContactRequest)
Only 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.
batchPutContactRequest - Future<BatchPutContactResult> batchPutContactAsync(BatchPutContactRequest batchPutContactRequest, AsyncHandler<BatchPutContactRequest,BatchPutContactResult> asyncHandler)
Only 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.
batchPutContactRequest - 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.Future<ClaimPhoneNumberResult> claimPhoneNumberAsync(ClaimPhoneNumberRequest claimPhoneNumberRequest)
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, 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.
claimPhoneNumberRequest - Future<ClaimPhoneNumberResult> claimPhoneNumberAsync(ClaimPhoneNumberRequest claimPhoneNumberRequest, AsyncHandler<ClaimPhoneNumberRequest,ClaimPhoneNumberResult> asyncHandler)
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, 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.
claimPhoneNumberRequest - 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.Future<CompleteAttachedFileUploadResult> completeAttachedFileUploadAsync(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest)
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUploadRequest - Request to CompleteAttachedFileUpload APIFuture<CompleteAttachedFileUploadResult> completeAttachedFileUploadAsync(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest, AsyncHandler<CompleteAttachedFileUploadRequest,CompleteAttachedFileUploadResult> asyncHandler)
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUploadRequest - 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.Future<CreateAgentStatusResult> createAgentStatusAsync(CreateAgentStatusRequest createAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusRequest - Future<CreateAgentStatusResult> createAgentStatusAsync(CreateAgentStatusRequest createAgentStatusRequest, AsyncHandler<CreateAgentStatusRequest,CreateAgentStatusResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatusRequest - 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.Future<CreateContactFlowResult> createContactFlowAsync(CreateContactFlowRequest createContactFlowRequest)
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowRequest - Future<CreateContactFlowResult> createContactFlowAsync(CreateContactFlowRequest createContactFlowRequest, AsyncHandler<CreateContactFlowRequest,CreateContactFlowResult> asyncHandler)
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlowRequest - 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.Future<CreateContactFlowModuleResult> createContactFlowModuleAsync(CreateContactFlowModuleRequest createContactFlowModuleRequest)
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModuleRequest - Future<CreateContactFlowModuleResult> createContactFlowModuleAsync(CreateContactFlowModuleRequest createContactFlowModuleRequest, AsyncHandler<CreateContactFlowModuleRequest,CreateContactFlowModuleResult> asyncHandler)
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModuleRequest - 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.Future<CreateEvaluationFormResult> createEvaluationFormAsync(CreateEvaluationFormRequest createEvaluationFormRequest)
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
createEvaluationFormRequest - Future<CreateEvaluationFormResult> createEvaluationFormAsync(CreateEvaluationFormRequest createEvaluationFormRequest, AsyncHandler<CreateEvaluationFormRequest,CreateEvaluationFormResult> asyncHandler)
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
createEvaluationFormRequest - 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.Future<CreateHoursOfOperationResult> createHoursOfOperationAsync(CreateHoursOfOperationRequest createHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationRequest - Future<CreateHoursOfOperationResult> createHoursOfOperationAsync(CreateHoursOfOperationRequest createHoursOfOperationRequest, AsyncHandler<CreateHoursOfOperationRequest,CreateHoursOfOperationResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperationRequest - 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.Future<CreateInstanceResult> createInstanceAsync(CreateInstanceRequest createInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
createInstanceRequest - Future<CreateInstanceResult> createInstanceAsync(CreateInstanceRequest createInstanceRequest, AsyncHandler<CreateInstanceRequest,CreateInstanceResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
createInstanceRequest - 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.Future<CreateIntegrationAssociationResult> createIntegrationAssociationAsync(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationRequest - Future<CreateIntegrationAssociationResult> createIntegrationAssociationAsync(CreateIntegrationAssociationRequest createIntegrationAssociationRequest, AsyncHandler<CreateIntegrationAssociationRequest,CreateIntegrationAssociationResult> asyncHandler)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociationRequest - 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.Future<CreateParticipantResult> createParticipantAsync(CreateParticipantRequest createParticipantRequest)
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantRequest - Future<CreateParticipantResult> createParticipantAsync(CreateParticipantRequest createParticipantRequest, AsyncHandler<CreateParticipantRequest,CreateParticipantResult> asyncHandler)
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipantRequest - 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.Future<CreatePersistentContactAssociationResult> createPersistentContactAssociationAsync(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest)
Enables 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.
createPersistentContactAssociationRequest - Future<CreatePersistentContactAssociationResult> createPersistentContactAssociationAsync(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest, AsyncHandler<CreatePersistentContactAssociationRequest,CreatePersistentContactAssociationResult> asyncHandler)
Enables 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.
createPersistentContactAssociationRequest - 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.Future<CreatePredefinedAttributeResult> createPredefinedAttributeAsync(CreatePredefinedAttributeRequest createPredefinedAttributeRequest)
Creates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttributeRequest - Future<CreatePredefinedAttributeResult> createPredefinedAttributeAsync(CreatePredefinedAttributeRequest createPredefinedAttributeRequest, AsyncHandler<CreatePredefinedAttributeRequest,CreatePredefinedAttributeResult> asyncHandler)
Creates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttributeRequest - 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.Future<CreatePromptResult> createPromptAsync(CreatePromptRequest createPromptRequest)
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPromptRequest - Future<CreatePromptResult> createPromptAsync(CreatePromptRequest createPromptRequest, AsyncHandler<CreatePromptRequest,CreatePromptResult> asyncHandler)
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPromptRequest - 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.Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the 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.
createQueueRequest - Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the 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.
createQueueRequest - 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.Future<CreateQuickConnectResult> createQuickConnectAsync(CreateQuickConnectRequest createQuickConnectRequest)
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnectRequest - Future<CreateQuickConnectResult> createQuickConnectAsync(CreateQuickConnectRequest createQuickConnectRequest, AsyncHandler<CreateQuickConnectRequest,CreateQuickConnectResult> asyncHandler)
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnectRequest - 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.Future<CreateRoutingProfileResult> createRoutingProfileAsync(CreateRoutingProfileRequest createRoutingProfileRequest)
Creates a new routing profile.
createRoutingProfileRequest - Future<CreateRoutingProfileResult> createRoutingProfileAsync(CreateRoutingProfileRequest createRoutingProfileRequest, AsyncHandler<CreateRoutingProfileRequest,CreateRoutingProfileResult> asyncHandler)
Creates a new routing profile.
createRoutingProfileRequest - 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.Future<CreateRuleResult> createRuleAsync(CreateRuleRequest createRuleRequest)
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleRequest - Future<CreateRuleResult> createRuleAsync(CreateRuleRequest createRuleRequest, AsyncHandler<CreateRuleRequest,CreateRuleResult> asyncHandler)
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRuleRequest - 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.Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a security profile.
createSecurityProfileRequest - Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest createSecurityProfileRequest, AsyncHandler<CreateSecurityProfileRequest,CreateSecurityProfileResult> asyncHandler)
Creates a security profile.
createSecurityProfileRequest - 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.Future<CreateTaskTemplateResult> createTaskTemplateAsync(CreateTaskTemplateRequest createTaskTemplateRequest)
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplateRequest - Future<CreateTaskTemplateResult> createTaskTemplateAsync(CreateTaskTemplateRequest createTaskTemplateRequest, AsyncHandler<CreateTaskTemplateRequest,CreateTaskTemplateResult> asyncHandler)
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplateRequest - 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.Future<CreateTrafficDistributionGroupResult> createTrafficDistributionGroupAsync(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)
Creates 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.
createTrafficDistributionGroupRequest - Future<CreateTrafficDistributionGroupResult> createTrafficDistributionGroupAsync(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest, AsyncHandler<CreateTrafficDistributionGroupRequest,CreateTrafficDistributionGroupResult> asyncHandler)
Creates 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.
createTrafficDistributionGroupRequest - 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.Future<CreateUseCaseResult> createUseCaseAsync(CreateUseCaseRequest createUseCaseRequest)
Creates a use case for an integration association.
createUseCaseRequest - Future<CreateUseCaseResult> createUseCaseAsync(CreateUseCaseRequest createUseCaseRequest, AsyncHandler<CreateUseCaseRequest,CreateUseCaseResult> asyncHandler)
Creates a use case for an integration association.
createUseCaseRequest - 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.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates 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.
createUserRequest - Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates 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.
createUserRequest - 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.Future<CreateUserHierarchyGroupResult> createUserHierarchyGroupAsync(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
Creates a new user hierarchy group.
createUserHierarchyGroupRequest - Future<CreateUserHierarchyGroupResult> createUserHierarchyGroupAsync(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest, AsyncHandler<CreateUserHierarchyGroupRequest,CreateUserHierarchyGroupResult> asyncHandler)
Creates a new user hierarchy group.
createUserHierarchyGroupRequest - 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.Future<CreateViewResult> createViewAsync(CreateViewRequest createViewRequest)
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.
createViewRequest - Future<CreateViewResult> createViewAsync(CreateViewRequest createViewRequest, AsyncHandler<CreateViewRequest,CreateViewResult> asyncHandler)
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.
createViewRequest - 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.Future<CreateViewVersionResult> createViewVersionAsync(CreateViewVersionRequest createViewVersionRequest)
Publishes 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.
createViewVersionRequest - Future<CreateViewVersionResult> createViewVersionAsync(CreateViewVersionRequest createViewVersionRequest, AsyncHandler<CreateViewVersionRequest,CreateViewVersionResult> asyncHandler)
Publishes 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.
createViewVersionRequest - 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.Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest createVocabularyRequest)
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
createVocabularyRequest - Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest createVocabularyRequest, AsyncHandler<CreateVocabularyRequest,CreateVocabularyResult> asyncHandler)
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
createVocabularyRequest - 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.Future<DeactivateEvaluationFormResult> deactivateEvaluationFormAsync(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
deactivateEvaluationFormRequest - Future<DeactivateEvaluationFormResult> deactivateEvaluationFormAsync(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest, AsyncHandler<DeactivateEvaluationFormRequest,DeactivateEvaluationFormResult> asyncHandler)
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
deactivateEvaluationFormRequest - 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.Future<DeleteAttachedFileResult> deleteAttachedFileAsync(DeleteAttachedFileRequest deleteAttachedFileRequest)
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFileRequest - Request to DeleteAttachedFile APIFuture<DeleteAttachedFileResult> deleteAttachedFileAsync(DeleteAttachedFileRequest deleteAttachedFileRequest, AsyncHandler<DeleteAttachedFileRequest,DeleteAttachedFileResult> asyncHandler)
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFileRequest - 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.Future<DeleteContactEvaluationResult> deleteContactEvaluationAsync(DeleteContactEvaluationRequest deleteContactEvaluationRequest)
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationRequest - Future<DeleteContactEvaluationResult> deleteContactEvaluationAsync(DeleteContactEvaluationRequest deleteContactEvaluationRequest, AsyncHandler<DeleteContactEvaluationRequest,DeleteContactEvaluationResult> asyncHandler)
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluationRequest - 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.Future<DeleteContactFlowResult> deleteContactFlowAsync(DeleteContactFlowRequest deleteContactFlowRequest)
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlowRequest - Future<DeleteContactFlowResult> deleteContactFlowAsync(DeleteContactFlowRequest deleteContactFlowRequest, AsyncHandler<DeleteContactFlowRequest,DeleteContactFlowResult> asyncHandler)
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlowRequest - 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.Future<DeleteContactFlowModuleResult> deleteContactFlowModuleAsync(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
Deletes the specified flow module.
deleteContactFlowModuleRequest - Future<DeleteContactFlowModuleResult> deleteContactFlowModuleAsync(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest, AsyncHandler<DeleteContactFlowModuleRequest,DeleteContactFlowModuleResult> asyncHandler)
Deletes the specified flow module.
deleteContactFlowModuleRequest - 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.Future<DeleteEvaluationFormResult> deleteEvaluationFormAsync(DeleteEvaluationFormRequest deleteEvaluationFormRequest)
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
deleteEvaluationFormRequest - Future<DeleteEvaluationFormResult> deleteEvaluationFormAsync(DeleteEvaluationFormRequest deleteEvaluationFormRequest, AsyncHandler<DeleteEvaluationFormRequest,DeleteEvaluationFormResult> asyncHandler)
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
deleteEvaluationFormRequest - 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.Future<DeleteHoursOfOperationResult> deleteHoursOfOperationAsync(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationRequest - Future<DeleteHoursOfOperationResult> deleteHoursOfOperationAsync(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest, AsyncHandler<DeleteHoursOfOperationRequest,DeleteHoursOfOperationResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperationRequest - 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.Future<DeleteInstanceResult> deleteInstanceAsync(DeleteInstanceRequest deleteInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
deleteInstanceRequest - Future<DeleteInstanceResult> deleteInstanceAsync(DeleteInstanceRequest deleteInstanceRequest, AsyncHandler<DeleteInstanceRequest,DeleteInstanceResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
deleteInstanceRequest - 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.Future<DeleteIntegrationAssociationResult> deleteIntegrationAssociationAsync(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationRequest - Future<DeleteIntegrationAssociationResult> deleteIntegrationAssociationAsync(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest, AsyncHandler<DeleteIntegrationAssociationRequest,DeleteIntegrationAssociationResult> asyncHandler)
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationRequest - 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.Future<DeletePredefinedAttributeResult> deletePredefinedAttributeAsync(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest)
Deletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttributeRequest - Future<DeletePredefinedAttributeResult> deletePredefinedAttributeAsync(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest, AsyncHandler<DeletePredefinedAttributeRequest,DeletePredefinedAttributeResult> asyncHandler)
Deletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttributeRequest - 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.Future<DeletePromptResult> deletePromptAsync(DeletePromptRequest deletePromptRequest)
Deletes a prompt.
deletePromptRequest - Future<DeletePromptResult> deletePromptAsync(DeletePromptRequest deletePromptRequest, AsyncHandler<DeletePromptRequest,DeletePromptResult> asyncHandler)
Deletes a prompt.
deletePromptRequest - 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.Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
Deletes a queue.
deleteQueueRequest - Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
Deletes a queue.
deleteQueueRequest - 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.Future<DeleteQuickConnectResult> deleteQuickConnectAsync(DeleteQuickConnectRequest deleteQuickConnectRequest)
Deletes 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.
deleteQuickConnectRequest - Future<DeleteQuickConnectResult> deleteQuickConnectAsync(DeleteQuickConnectRequest deleteQuickConnectRequest, AsyncHandler<DeleteQuickConnectRequest,DeleteQuickConnectResult> asyncHandler)
Deletes 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.
deleteQuickConnectRequest - 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.Future<DeleteRoutingProfileResult> deleteRoutingProfileAsync(DeleteRoutingProfileRequest deleteRoutingProfileRequest)
Deletes a routing profile.
deleteRoutingProfileRequest - Future<DeleteRoutingProfileResult> deleteRoutingProfileAsync(DeleteRoutingProfileRequest deleteRoutingProfileRequest, AsyncHandler<DeleteRoutingProfileRequest,DeleteRoutingProfileResult> asyncHandler)
Deletes a routing profile.
deleteRoutingProfileRequest - 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.Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest deleteRuleRequest)
Deletes a rule for the specified Amazon Connect instance.
deleteRuleRequest - Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest deleteRuleRequest, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
Deletes a rule for the specified Amazon Connect instance.
deleteRuleRequest - 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.Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a security profile.
deleteSecurityProfileRequest - Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest deleteSecurityProfileRequest, AsyncHandler<DeleteSecurityProfileRequest,DeleteSecurityProfileResult> asyncHandler)
Deletes a security profile.
deleteSecurityProfileRequest - 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.Future<DeleteTaskTemplateResult> deleteTaskTemplateAsync(DeleteTaskTemplateRequest deleteTaskTemplateRequest)
Deletes the task template.
deleteTaskTemplateRequest - Future<DeleteTaskTemplateResult> deleteTaskTemplateAsync(DeleteTaskTemplateRequest deleteTaskTemplateRequest, AsyncHandler<DeleteTaskTemplateRequest,DeleteTaskTemplateResult> asyncHandler)
Deletes the task template.
deleteTaskTemplateRequest - 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.Future<DeleteTrafficDistributionGroupResult> deleteTrafficDistributionGroupAsync(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
deleteTrafficDistributionGroupRequest - Future<DeleteTrafficDistributionGroupResult> deleteTrafficDistributionGroupAsync(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest, AsyncHandler<DeleteTrafficDistributionGroupRequest,DeleteTrafficDistributionGroupResult> asyncHandler)
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
deleteTrafficDistributionGroupRequest - 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.Future<DeleteUseCaseResult> deleteUseCaseAsync(DeleteUseCaseRequest deleteUseCaseRequest)
Deletes a use case from an integration association.
deleteUseCaseRequest - Future<DeleteUseCaseResult> deleteUseCaseAsync(DeleteUseCaseRequest deleteUseCaseRequest, AsyncHandler<DeleteUseCaseRequest,DeleteUseCaseResult> asyncHandler)
Deletes a use case from an integration association.
deleteUseCaseRequest - 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.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
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.
deleteUserRequest - Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
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.
deleteUserRequest - 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.Future<DeleteUserHierarchyGroupResult> deleteUserHierarchyGroupAsync(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupRequest - Future<DeleteUserHierarchyGroupResult> deleteUserHierarchyGroupAsync(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest, AsyncHandler<DeleteUserHierarchyGroupRequest,DeleteUserHierarchyGroupResult> asyncHandler)
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupRequest - 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.Future<DeleteViewResult> deleteViewAsync(DeleteViewRequest deleteViewRequest)
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteViewRequest - Future<DeleteViewResult> deleteViewAsync(DeleteViewRequest deleteViewRequest, AsyncHandler<DeleteViewRequest,DeleteViewResult> asyncHandler)
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteViewRequest - 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.Future<DeleteViewVersionResult> deleteViewVersionAsync(DeleteViewVersionRequest deleteViewVersionRequest)
Deletes the particular version specified in ViewVersion identifier.
deleteViewVersionRequest - Future<DeleteViewVersionResult> deleteViewVersionAsync(DeleteViewVersionRequest deleteViewVersionRequest, AsyncHandler<DeleteViewVersionRequest,DeleteViewVersionResult> asyncHandler)
Deletes the particular version specified in ViewVersion identifier.
deleteViewVersionRequest - 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.Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest deleteVocabularyRequest)
Deletes the vocabulary that has the given identifier.
deleteVocabularyRequest - Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest deleteVocabularyRequest, AsyncHandler<DeleteVocabularyRequest,DeleteVocabularyResult> asyncHandler)
Deletes the vocabulary that has the given identifier.
deleteVocabularyRequest - 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.Future<DescribeAgentStatusResult> describeAgentStatusAsync(DescribeAgentStatusRequest describeAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusRequest - Future<DescribeAgentStatusResult> describeAgentStatusAsync(DescribeAgentStatusRequest describeAgentStatusRequest, AsyncHandler<DescribeAgentStatusRequest,DescribeAgentStatusResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatusRequest - 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.Future<DescribeAuthenticationProfileResult> describeAuthenticationProfileAsync(DescribeAuthenticationProfileRequest describeAuthenticationProfileRequest)
This 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.
describeAuthenticationProfileRequest - Future<DescribeAuthenticationProfileResult> describeAuthenticationProfileAsync(DescribeAuthenticationProfileRequest describeAuthenticationProfileRequest, AsyncHandler<DescribeAuthenticationProfileRequest,DescribeAuthenticationProfileResult> asyncHandler)
This 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.
describeAuthenticationProfileRequest - 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.Future<DescribeContactResult> describeContactAsync(DescribeContactRequest describeContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
describeContactRequest - Future<DescribeContactResult> describeContactAsync(DescribeContactRequest describeContactRequest, AsyncHandler<DescribeContactRequest,DescribeContactResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
describeContactRequest - 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.Future<DescribeContactEvaluationResult> describeContactEvaluationAsync(DescribeContactEvaluationRequest describeContactEvaluationRequest)
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationRequest - Future<DescribeContactEvaluationResult> describeContactEvaluationAsync(DescribeContactEvaluationRequest describeContactEvaluationRequest, AsyncHandler<DescribeContactEvaluationRequest,DescribeContactEvaluationResult> asyncHandler)
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluationRequest - 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.Future<DescribeContactFlowResult> describeContactFlowAsync(DescribeContactFlowRequest describeContactFlowRequest)
Describes 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
describeContactFlowRequest - Future<DescribeContactFlowResult> describeContactFlowAsync(DescribeContactFlowRequest describeContactFlowRequest, AsyncHandler<DescribeContactFlowRequest,DescribeContactFlowResult> asyncHandler)
Describes 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
describeContactFlowRequest - 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.Future<DescribeContactFlowModuleResult> describeContactFlowModuleAsync(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
Describes 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.
describeContactFlowModuleRequest - Future<DescribeContactFlowModuleResult> describeContactFlowModuleAsync(DescribeContactFlowModuleRequest describeContactFlowModuleRequest, AsyncHandler<DescribeContactFlowModuleRequest,DescribeContactFlowModuleResult> asyncHandler)
Describes 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.
describeContactFlowModuleRequest - 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.Future<DescribeEvaluationFormResult> describeEvaluationFormAsync(DescribeEvaluationFormRequest describeEvaluationFormRequest)
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
describeEvaluationFormRequest - Future<DescribeEvaluationFormResult> describeEvaluationFormAsync(DescribeEvaluationFormRequest describeEvaluationFormRequest, AsyncHandler<DescribeEvaluationFormRequest,DescribeEvaluationFormResult> asyncHandler)
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
describeEvaluationFormRequest - 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.Future<DescribeHoursOfOperationResult> describeHoursOfOperationAsync(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationRequest - Future<DescribeHoursOfOperationResult> describeHoursOfOperationAsync(DescribeHoursOfOperationRequest describeHoursOfOperationRequest, AsyncHandler<DescribeHoursOfOperationRequest,DescribeHoursOfOperationResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperationRequest - 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.Future<DescribeInstanceResult> describeInstanceAsync(DescribeInstanceRequest describeInstanceRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstanceRequest - Future<DescribeInstanceResult> describeInstanceAsync(DescribeInstanceRequest describeInstanceRequest, AsyncHandler<DescribeInstanceRequest,DescribeInstanceResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstanceRequest - 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.Future<DescribeInstanceAttributeResult> describeInstanceAttributeAsync(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeRequest - Future<DescribeInstanceAttributeResult> describeInstanceAttributeAsync(DescribeInstanceAttributeRequest describeInstanceAttributeRequest, AsyncHandler<DescribeInstanceAttributeRequest,DescribeInstanceAttributeResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeRequest - 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.Future<DescribeInstanceStorageConfigResult> describeInstanceStorageConfigAsync(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfigRequest - Future<DescribeInstanceStorageConfigResult> describeInstanceStorageConfigAsync(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest, AsyncHandler<DescribeInstanceStorageConfigRequest,DescribeInstanceStorageConfigResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfigRequest - 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.Future<DescribePhoneNumberResult> describePhoneNumberAsync(DescribePhoneNumberRequest describePhoneNumberRequest)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the
PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution
group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will
receive a ResourceNotFoundException.
describePhoneNumberRequest - Future<DescribePhoneNumberResult> describePhoneNumberAsync(DescribePhoneNumberRequest describePhoneNumberRequest, AsyncHandler<DescribePhoneNumberRequest,DescribePhoneNumberResult> asyncHandler)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the
PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution
group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will
receive a ResourceNotFoundException.
describePhoneNumberRequest - 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.Future<DescribePredefinedAttributeResult> describePredefinedAttributeAsync(DescribePredefinedAttributeRequest describePredefinedAttributeRequest)
Describes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttributeRequest - Future<DescribePredefinedAttributeResult> describePredefinedAttributeAsync(DescribePredefinedAttributeRequest describePredefinedAttributeRequest, AsyncHandler<DescribePredefinedAttributeRequest,DescribePredefinedAttributeResult> asyncHandler)
Describes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttributeRequest - 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.Future<DescribePromptResult> describePromptAsync(DescribePromptRequest describePromptRequest)
Describes the prompt.
describePromptRequest - Future<DescribePromptResult> describePromptAsync(DescribePromptRequest describePromptRequest, AsyncHandler<DescribePromptRequest,DescribePromptResult> asyncHandler)
Describes the prompt.
describePromptRequest - 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.Future<DescribeQueueResult> describeQueueAsync(DescribeQueueRequest describeQueueRequest)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueRequest - Future<DescribeQueueResult> describeQueueAsync(DescribeQueueRequest describeQueueRequest, AsyncHandler<DescribeQueueRequest,DescribeQueueResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueueRequest - 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.Future<DescribeQuickConnectResult> describeQuickConnectAsync(DescribeQuickConnectRequest describeQuickConnectRequest)
Describes the quick connect.
describeQuickConnectRequest - Future<DescribeQuickConnectResult> describeQuickConnectAsync(DescribeQuickConnectRequest describeQuickConnectRequest, AsyncHandler<DescribeQuickConnectRequest,DescribeQuickConnectResult> asyncHandler)
Describes the quick connect.
describeQuickConnectRequest - 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.Future<DescribeRoutingProfileResult> describeRoutingProfileAsync(DescribeRoutingProfileRequest describeRoutingProfileRequest)
Describes the specified routing profile.
describeRoutingProfileRequest - Future<DescribeRoutingProfileResult> describeRoutingProfileAsync(DescribeRoutingProfileRequest describeRoutingProfileRequest, AsyncHandler<DescribeRoutingProfileRequest,DescribeRoutingProfileResult> asyncHandler)
Describes the specified routing profile.
describeRoutingProfileRequest - 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.Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest describeRuleRequest)
Describes a rule for the specified Amazon Connect instance.
describeRuleRequest - Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest describeRuleRequest, AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
Describes a rule for the specified Amazon Connect instance.
describeRuleRequest - 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.Future<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets basic information about the security profle.
describeSecurityProfileRequest - Future<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest describeSecurityProfileRequest, AsyncHandler<DescribeSecurityProfileRequest,DescribeSecurityProfileResult> asyncHandler)
Gets basic information about the security profle.
describeSecurityProfileRequest - 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.Future<DescribeTrafficDistributionGroupResult> describeTrafficDistributionGroupAsync(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroupRequest - Future<DescribeTrafficDistributionGroupResult> describeTrafficDistributionGroupAsync(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest, AsyncHandler<DescribeTrafficDistributionGroupRequest,DescribeTrafficDistributionGroupResult> asyncHandler)
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroupRequest - 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.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Describes 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.
describeUserRequest - Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Describes 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.
describeUserRequest - 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.Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Describes the specified hierarchy group.
describeUserHierarchyGroupRequest - Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest, AsyncHandler<DescribeUserHierarchyGroupRequest,DescribeUserHierarchyGroupResult> asyncHandler)
Describes the specified hierarchy group.
describeUserHierarchyGroupRequest - 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.Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureRequest - Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest, AsyncHandler<DescribeUserHierarchyStructureRequest,DescribeUserHierarchyStructureResult> asyncHandler)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureRequest - 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.Future<DescribeViewResult> describeViewAsync(DescribeViewRequest describeViewRequest)
Retrieves 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.
describeViewRequest - Future<DescribeViewResult> describeViewAsync(DescribeViewRequest describeViewRequest, AsyncHandler<DescribeViewRequest,DescribeViewResult> asyncHandler)
Retrieves 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.
describeViewRequest - 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.Future<DescribeVocabularyResult> describeVocabularyAsync(DescribeVocabularyRequest describeVocabularyRequest)
Describes the specified vocabulary.
describeVocabularyRequest - Future<DescribeVocabularyResult> describeVocabularyAsync(DescribeVocabularyRequest describeVocabularyRequest, AsyncHandler<DescribeVocabularyRequest,DescribeVocabularyResult> asyncHandler)
Describes the specified vocabulary.
describeVocabularyRequest - 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.Future<DisassociateAnalyticsDataSetResult> disassociateAnalyticsDataSetAsync(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest)
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSetRequest - Future<DisassociateAnalyticsDataSetResult> disassociateAnalyticsDataSetAsync(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest, AsyncHandler<DisassociateAnalyticsDataSetRequest,DisassociateAnalyticsDataSetResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSetRequest - 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.Future<DisassociateApprovedOriginResult> disassociateApprovedOriginAsync(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginRequest - Future<DisassociateApprovedOriginResult> disassociateApprovedOriginAsync(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest, AsyncHandler<DisassociateApprovedOriginRequest,DisassociateApprovedOriginResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginRequest - 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.Future<DisassociateBotResult> disassociateBotAsync(DisassociateBotRequest disassociateBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
disassociateBotRequest - Future<DisassociateBotResult> disassociateBotAsync(DisassociateBotRequest disassociateBotRequest, AsyncHandler<DisassociateBotRequest,DisassociateBotResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
disassociateBotRequest - 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.Future<DisassociateFlowResult> disassociateFlowAsync(DisassociateFlowRequest disassociateFlowRequest)
Disassociates a connect resource from a flow.
disassociateFlowRequest - Future<DisassociateFlowResult> disassociateFlowAsync(DisassociateFlowRequest disassociateFlowRequest, AsyncHandler<DisassociateFlowRequest,DisassociateFlowResult> asyncHandler)
Disassociates a connect resource from a flow.
disassociateFlowRequest - 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.Future<DisassociateInstanceStorageConfigResult> disassociateInstanceStorageConfigAsync(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfigRequest - Future<DisassociateInstanceStorageConfigResult> disassociateInstanceStorageConfigAsync(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest, AsyncHandler<DisassociateInstanceStorageConfigRequest,DisassociateInstanceStorageConfigResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfigRequest - 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.Future<DisassociateLambdaFunctionResult> disassociateLambdaFunctionAsync(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
disassociateLambdaFunctionRequest - Future<DisassociateLambdaFunctionResult> disassociateLambdaFunctionAsync(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest, AsyncHandler<DisassociateLambdaFunctionRequest,DisassociateLambdaFunctionResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
disassociateLambdaFunctionRequest - 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.Future<DisassociateLexBotResult> disassociateLexBotAsync(DisassociateLexBotRequest disassociateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBotRequest - Future<DisassociateLexBotResult> disassociateLexBotAsync(DisassociateLexBotRequest disassociateLexBotRequest, AsyncHandler<DisassociateLexBotRequest,DisassociateLexBotResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBotRequest - 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.Future<DisassociatePhoneNumberContactFlowResult> disassociatePhoneNumberContactFlowAsync(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
disassociatePhoneNumberContactFlowRequest - Future<DisassociatePhoneNumberContactFlowResult> disassociatePhoneNumberContactFlowAsync(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest, AsyncHandler<DisassociatePhoneNumberContactFlowRequest,DisassociatePhoneNumberContactFlowResult> asyncHandler)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
disassociatePhoneNumberContactFlowRequest - 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.Future<DisassociateQueueQuickConnectsResult> disassociateQueueQuickConnectsAsync(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsRequest - Future<DisassociateQueueQuickConnectsResult> disassociateQueueQuickConnectsAsync(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest, AsyncHandler<DisassociateQueueQuickConnectsRequest,DisassociateQueueQuickConnectsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnectsRequest - 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.Future<DisassociateRoutingProfileQueuesResult> disassociateRoutingProfileQueuesAsync(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesRequest - Future<DisassociateRoutingProfileQueuesResult> disassociateRoutingProfileQueuesAsync(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest, AsyncHandler<DisassociateRoutingProfileQueuesRequest,DisassociateRoutingProfileQueuesResult> asyncHandler)
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesRequest - 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.Future<DisassociateSecurityKeyResult> disassociateSecurityKeyAsync(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyRequest - Future<DisassociateSecurityKeyResult> disassociateSecurityKeyAsync(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest, AsyncHandler<DisassociateSecurityKeyRequest,DisassociateSecurityKeyResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyRequest - 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.Future<DisassociateTrafficDistributionGroupUserResult> disassociateTrafficDistributionGroupUserAsync(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserRequest - Future<DisassociateTrafficDistributionGroupUserResult> disassociateTrafficDistributionGroupUserAsync(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest, AsyncHandler<DisassociateTrafficDistributionGroupUserRequest,DisassociateTrafficDistributionGroupUserResult> asyncHandler)
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUserRequest - 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.Future<DisassociateUserProficienciesResult> disassociateUserProficienciesAsync(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest)
Disassociates a set of proficiencies from a user.
disassociateUserProficienciesRequest - Future<DisassociateUserProficienciesResult> disassociateUserProficienciesAsync(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest, AsyncHandler<DisassociateUserProficienciesRequest,DisassociateUserProficienciesResult> asyncHandler)
Disassociates a set of proficiencies from a user.
disassociateUserProficienciesRequest - 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.Future<DismissUserContactResult> dismissUserContactAsync(DismissUserContactRequest dismissUserContactRequest)
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to
receive a new routed contact. Contacts can only be dismissed if they are in a MISSED,
ERROR, ENDED, or REJECTED state in the Agent Event Stream.
dismissUserContactRequest - Future<DismissUserContactResult> dismissUserContactAsync(DismissUserContactRequest dismissUserContactRequest, AsyncHandler<DismissUserContactRequest,DismissUserContactResult> asyncHandler)
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to
receive a new routed contact. Contacts can only be dismissed if they are in a MISSED,
ERROR, ENDED, or REJECTED state in the Agent Event Stream.
dismissUserContactRequest - 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.Future<GetAttachedFileResult> getAttachedFileAsync(GetAttachedFileRequest getAttachedFileRequest)
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.
getAttachedFileRequest - Request to GetAttachedFile API.Future<GetAttachedFileResult> getAttachedFileAsync(GetAttachedFileRequest getAttachedFileRequest, AsyncHandler<GetAttachedFileRequest,GetAttachedFileResult> asyncHandler)
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.
getAttachedFileRequest - 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.Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes for the specified contact.
getContactAttributesRequest - Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest, AsyncHandler<GetContactAttributesRequest,GetContactAttributesResult> asyncHandler)
Retrieves the contact attributes for the specified contact.
getContactAttributesRequest - 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.Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricDataRequest - Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest, AsyncHandler<GetCurrentMetricDataRequest,GetCurrentMetricDataResult> asyncHandler)
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricDataRequest - 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.Future<GetCurrentUserDataResult> getCurrentUserDataAsync(GetCurrentUserDataRequest getCurrentUserDataRequest)
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataRequest - Future<GetCurrentUserDataResult> getCurrentUserDataAsync(GetCurrentUserDataRequest getCurrentUserDataRequest, AsyncHandler<GetCurrentUserDataRequest,GetCurrentUserDataResult> asyncHandler)
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserDataRequest - 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.Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest)
Supports 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
getFederationTokenRequest - Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest, AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
Supports 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
getFederationTokenRequest - 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.Future<GetFlowAssociationResult> getFlowAssociationAsync(GetFlowAssociationRequest getFlowAssociationRequest)
Retrieves the flow associated for a given resource.
getFlowAssociationRequest - Future<GetFlowAssociationResult> getFlowAssociationAsync(GetFlowAssociationRequest getFlowAssociationRequest, AsyncHandler<GetFlowAssociationRequest,GetFlowAssociationResult> asyncHandler)
Retrieves the flow associated for a given resource.
getFlowAssociationRequest - 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.Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest)
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
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.
getMetricDataRequest - Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest, AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
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.
getMetricDataRequest - 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.Future<GetMetricDataV2Result> getMetricDataV2Async(GetMetricDataV2Request getMetricDataV2Request)
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the
previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to
filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve
historical data for the last 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.
getMetricDataV2Request - Future<GetMetricDataV2Result> getMetricDataV2Async(GetMetricDataV2Request getMetricDataV2Request, AsyncHandler<GetMetricDataV2Request,GetMetricDataV2Result> asyncHandler)
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the
previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to
filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve
historical data for the last 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.
getMetricDataV2Request - 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.Future<GetPromptFileResult> getPromptFileAsync(GetPromptFileRequest getPromptFileRequest)
Gets the prompt file.
getPromptFileRequest - Future<GetPromptFileResult> getPromptFileAsync(GetPromptFileRequest getPromptFileRequest, AsyncHandler<GetPromptFileRequest,GetPromptFileResult> asyncHandler)
Gets the prompt file.
getPromptFileRequest - 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.Future<GetTaskTemplateResult> getTaskTemplateAsync(GetTaskTemplateRequest getTaskTemplateRequest)
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateRequest - Future<GetTaskTemplateResult> getTaskTemplateAsync(GetTaskTemplateRequest getTaskTemplateRequest, AsyncHandler<GetTaskTemplateRequest,GetTaskTemplateResult> asyncHandler)
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplateRequest - 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.Future<GetTrafficDistributionResult> getTrafficDistributionAsync(GetTrafficDistributionRequest getTrafficDistributionRequest)
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionRequest - Future<GetTrafficDistributionResult> getTrafficDistributionAsync(GetTrafficDistributionRequest getTrafficDistributionRequest, AsyncHandler<GetTrafficDistributionRequest,GetTrafficDistributionResult> asyncHandler)
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistributionRequest - 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.Future<ImportPhoneNumberResult> importPhoneNumberAsync(ImportPhoneNumberRequest importPhoneNumberRequest)
Imports 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.
importPhoneNumberRequest - Future<ImportPhoneNumberResult> importPhoneNumberAsync(ImportPhoneNumberRequest importPhoneNumberRequest, AsyncHandler<ImportPhoneNumberRequest,ImportPhoneNumberResult> asyncHandler)
Imports 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.
importPhoneNumberRequest - 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.Future<ListAgentStatusesResult> listAgentStatusesAsync(ListAgentStatusesRequest listAgentStatusesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesRequest - Future<ListAgentStatusesResult> listAgentStatusesAsync(ListAgentStatusesRequest listAgentStatusesRequest, AsyncHandler<ListAgentStatusesRequest,ListAgentStatusesResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatusesRequest - 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.Future<ListAnalyticsDataAssociationsResult> listAnalyticsDataAssociationsAsync(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest)
This 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.
listAnalyticsDataAssociationsRequest - Future<ListAnalyticsDataAssociationsResult> listAnalyticsDataAssociationsAsync(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest, AsyncHandler<ListAnalyticsDataAssociationsRequest,ListAnalyticsDataAssociationsResult> asyncHandler)
This 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.
listAnalyticsDataAssociationsRequest - 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.Future<ListApprovedOriginsResult> listApprovedOriginsAsync(ListApprovedOriginsRequest listApprovedOriginsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOriginsRequest - Future<ListApprovedOriginsResult> listApprovedOriginsAsync(ListApprovedOriginsRequest listApprovedOriginsRequest, AsyncHandler<ListApprovedOriginsRequest,ListApprovedOriginsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOriginsRequest - 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.Future<ListAuthenticationProfilesResult> listAuthenticationProfilesAsync(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest)
This 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.
listAuthenticationProfilesRequest - Future<ListAuthenticationProfilesResult> listAuthenticationProfilesAsync(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest, AsyncHandler<ListAuthenticationProfilesRequest,ListAuthenticationProfilesResult> asyncHandler)
This 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.
listAuthenticationProfilesRequest - 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.Future<ListBotsResult> listBotsAsync(ListBotsRequest listBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
listBotsRequest - Future<ListBotsResult> listBotsAsync(ListBotsRequest listBotsRequest, AsyncHandler<ListBotsRequest,ListBotsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
listBotsRequest - 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.Future<ListContactEvaluationsResult> listContactEvaluationsAsync(ListContactEvaluationsRequest listContactEvaluationsRequest)
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsRequest - Future<ListContactEvaluationsResult> listContactEvaluationsAsync(ListContactEvaluationsRequest listContactEvaluationsRequest, AsyncHandler<ListContactEvaluationsRequest,ListContactEvaluationsResult> asyncHandler)
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluationsRequest - 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.Future<ListContactFlowModulesResult> listContactFlowModulesAsync(ListContactFlowModulesRequest listContactFlowModulesRequest)
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesRequest - Future<ListContactFlowModulesResult> listContactFlowModulesAsync(ListContactFlowModulesRequest listContactFlowModulesRequest, AsyncHandler<ListContactFlowModulesRequest,ListContactFlowModulesResult> asyncHandler)
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModulesRequest - 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.Future<ListContactFlowsResult> listContactFlowsAsync(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
listContactFlowsRequest - Future<ListContactFlowsResult> listContactFlowsAsync(ListContactFlowsRequest listContactFlowsRequest, AsyncHandler<ListContactFlowsRequest,ListContactFlowsResult> asyncHandler)
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
listContactFlowsRequest - 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.Future<ListContactReferencesResult> listContactReferencesAsync(ListContactReferencesRequest listContactReferencesRequest)
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferencesRequest - Future<ListContactReferencesResult> listContactReferencesAsync(ListContactReferencesRequest listContactReferencesRequest, AsyncHandler<ListContactReferencesRequest,ListContactReferencesResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferencesRequest - 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.Future<ListDefaultVocabulariesResult> listDefaultVocabulariesAsync(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesRequest - Future<ListDefaultVocabulariesResult> listDefaultVocabulariesAsync(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest, AsyncHandler<ListDefaultVocabulariesRequest,ListDefaultVocabulariesResult> asyncHandler)
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabulariesRequest - 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.Future<ListEvaluationFormVersionsResult> listEvaluationFormVersionsAsync(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsRequest - Future<ListEvaluationFormVersionsResult> listEvaluationFormVersionsAsync(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest, AsyncHandler<ListEvaluationFormVersionsRequest,ListEvaluationFormVersionsResult> asyncHandler)
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersionsRequest - 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.Future<ListEvaluationFormsResult> listEvaluationFormsAsync(ListEvaluationFormsRequest listEvaluationFormsRequest)
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsRequest - Future<ListEvaluationFormsResult> listEvaluationFormsAsync(ListEvaluationFormsRequest listEvaluationFormsRequest, AsyncHandler<ListEvaluationFormsRequest,ListEvaluationFormsResult> asyncHandler)
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationFormsRequest - 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.Future<ListFlowAssociationsResult> listFlowAssociationsAsync(ListFlowAssociationsRequest listFlowAssociationsRequest)
List the flow association based on the filters.
listFlowAssociationsRequest - Future<ListFlowAssociationsResult> listFlowAssociationsAsync(ListFlowAssociationsRequest listFlowAssociationsRequest, AsyncHandler<ListFlowAssociationsRequest,ListFlowAssociationsResult> asyncHandler)
List the flow association based on the filters.
listFlowAssociationsRequest - 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.Future<ListHoursOfOperationsResult> listHoursOfOperationsAsync(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperationsRequest - Future<ListHoursOfOperationsResult> listHoursOfOperationsAsync(ListHoursOfOperationsRequest listHoursOfOperationsRequest, AsyncHandler<ListHoursOfOperationsRequest,ListHoursOfOperationsResult> asyncHandler)
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperationsRequest - 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.Future<ListInstanceAttributesResult> listInstanceAttributesAsync(ListInstanceAttributesRequest listInstanceAttributesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributesRequest - Future<ListInstanceAttributesResult> listInstanceAttributesAsync(ListInstanceAttributesRequest listInstanceAttributesRequest, AsyncHandler<ListInstanceAttributesRequest,ListInstanceAttributesResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributesRequest - 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.Future<ListInstanceStorageConfigsResult> listInstanceStorageConfigsAsync(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigsRequest - Future<ListInstanceStorageConfigsResult> listInstanceStorageConfigsAsync(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest, AsyncHandler<ListInstanceStorageConfigsRequest,ListInstanceStorageConfigsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigsRequest - 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.Future<ListInstancesResult> listInstancesAsync(ListInstancesRequest listInstancesRequest)
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstancesRequest - Future<ListInstancesResult> listInstancesAsync(ListInstancesRequest listInstancesRequest, AsyncHandler<ListInstancesRequest,ListInstancesResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstancesRequest - 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.Future<ListIntegrationAssociationsResult> listIntegrationAssociationsAsync(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsRequest - Future<ListIntegrationAssociationsResult> listIntegrationAssociationsAsync(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest, AsyncHandler<ListIntegrationAssociationsRequest,ListIntegrationAssociationsResult> asyncHandler)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociationsRequest - 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.Future<ListLambdaFunctionsResult> listLambdaFunctionsAsync(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
listLambdaFunctionsRequest - Future<ListLambdaFunctionsResult> listLambdaFunctionsAsync(ListLambdaFunctionsRequest listLambdaFunctionsRequest, AsyncHandler<ListLambdaFunctionsRequest,ListLambdaFunctionsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
listLambdaFunctionsRequest - 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.Future<ListLexBotsResult> listLexBotsAsync(ListLexBotsRequest listLexBotsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
listLexBotsRequest - Future<ListLexBotsResult> listLexBotsAsync(ListLexBotsRequest listLexBotsRequest, AsyncHandler<ListLexBotsRequest,ListLexBotsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
listLexBotsRequest - 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.Future<ListPhoneNumbersResult> listPhoneNumbersAsync(ListPhoneNumbersRequest listPhoneNumbersRequest)
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
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.
listPhoneNumbersRequest - Future<ListPhoneNumbersResult> listPhoneNumbersAsync(ListPhoneNumbersRequest listPhoneNumbersRequest, AsyncHandler<ListPhoneNumbersRequest,ListPhoneNumbersResult> asyncHandler)
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
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.
listPhoneNumbersRequest - 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.Future<ListPhoneNumbersV2Result> listPhoneNumbersV2Async(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided
TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions
associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the
instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers
claimed to the traffic distribution group.
listPhoneNumbersV2Request - Future<ListPhoneNumbersV2Result> listPhoneNumbersV2Async(ListPhoneNumbersV2Request listPhoneNumbersV2Request, AsyncHandler<ListPhoneNumbersV2Request,ListPhoneNumbersV2Result> asyncHandler)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided
TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions
associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the
instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers
claimed to the traffic distribution group.
listPhoneNumbersV2Request - 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.Future<ListPredefinedAttributesResult> listPredefinedAttributesAsync(ListPredefinedAttributesRequest listPredefinedAttributesRequest)
Lists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributesRequest - Future<ListPredefinedAttributesResult> listPredefinedAttributesAsync(ListPredefinedAttributesRequest listPredefinedAttributesRequest, AsyncHandler<ListPredefinedAttributesRequest,ListPredefinedAttributesResult> asyncHandler)
Lists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributesRequest - 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.Future<ListPromptsResult> listPromptsAsync(ListPromptsRequest listPromptsRequest)
Provides information about the prompts for the specified Amazon Connect instance.
listPromptsRequest - Future<ListPromptsResult> listPromptsAsync(ListPromptsRequest listPromptsRequest, AsyncHandler<ListPromptsRequest,ListPromptsResult> asyncHandler)
Provides information about the prompts for the specified Amazon Connect instance.
listPromptsRequest - 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.Future<ListQueueQuickConnectsResult> listQueueQuickConnectsAsync(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsRequest - Future<ListQueueQuickConnectsResult> listQueueQuickConnectsAsync(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest, AsyncHandler<ListQueueQuickConnectsRequest,ListQueueQuickConnectsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnectsRequest - 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.Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest)
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This
might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of
results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueuesRequest - Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This
might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of
results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueuesRequest - 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.Future<ListQuickConnectsResult> listQuickConnectsAsync(ListQuickConnectsRequest listQuickConnectsRequest)
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsRequest - Future<ListQuickConnectsResult> listQuickConnectsAsync(ListQuickConnectsRequest listQuickConnectsRequest, AsyncHandler<ListQuickConnectsRequest,ListQuickConnectsResult> asyncHandler)
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsRequest - 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.Future<ListRealtimeContactAnalysisSegmentsV2Result> listRealtimeContactAnalysisSegmentsV2Async(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request)
Provides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2Request - Future<ListRealtimeContactAnalysisSegmentsV2Result> listRealtimeContactAnalysisSegmentsV2Async(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request, AsyncHandler<ListRealtimeContactAnalysisSegmentsV2Request,ListRealtimeContactAnalysisSegmentsV2Result> asyncHandler)
Provides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2Request - 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.Future<ListRoutingProfileQueuesResult> listRoutingProfileQueuesAsync(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
Lists the queues associated with a routing profile.
listRoutingProfileQueuesRequest - Future<ListRoutingProfileQueuesResult> listRoutingProfileQueuesAsync(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest, AsyncHandler<ListRoutingProfileQueuesRequest,ListRoutingProfileQueuesResult> asyncHandler)
Lists the queues associated with a routing profile.
listRoutingProfileQueuesRequest - 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.Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfilesRequest - Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest, AsyncHandler<ListRoutingProfilesRequest,ListRoutingProfilesResult> asyncHandler)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfilesRequest - 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.Future<ListRulesResult> listRulesAsync(ListRulesRequest listRulesRequest)
List all rules for the specified Amazon Connect instance.
listRulesRequest - Future<ListRulesResult> listRulesAsync(ListRulesRequest listRulesRequest, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
List all rules for the specified Amazon Connect instance.
listRulesRequest - 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.Future<ListSecurityKeysResult> listSecurityKeysAsync(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeysRequest - Future<ListSecurityKeysResult> listSecurityKeysAsync(ListSecurityKeysRequest listSecurityKeysRequest, AsyncHandler<ListSecurityKeysRequest,ListSecurityKeysResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeysRequest - 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.Future<ListSecurityProfileApplicationsResult> listSecurityProfileApplicationsAsync(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest)
Returns a list of third-party applications in a specific security profile.
listSecurityProfileApplicationsRequest - Future<ListSecurityProfileApplicationsResult> listSecurityProfileApplicationsAsync(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest, AsyncHandler<ListSecurityProfileApplicationsRequest,ListSecurityProfileApplicationsResult> asyncHandler)
Returns a list of third-party applications in a specific security profile.
listSecurityProfileApplicationsRequest - 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.Future<ListSecurityProfilePermissionsResult> listSecurityProfilePermissionsAsync(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
Lists the permissions granted to a security profile.
listSecurityProfilePermissionsRequest - Future<ListSecurityProfilePermissionsResult> listSecurityProfilePermissionsAsync(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest, AsyncHandler<ListSecurityProfilePermissionsRequest,ListSecurityProfilePermissionsResult> asyncHandler)
Lists the permissions granted to a security profile.
listSecurityProfilePermissionsRequest - 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.Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest)
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfilesRequest - Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest, AsyncHandler<ListSecurityProfilesRequest,ListSecurityProfilesResult> asyncHandler)
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfilesRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResourceRequest - 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.Future<ListTaskTemplatesResult> listTaskTemplatesAsync(ListTaskTemplatesRequest listTaskTemplatesRequest)
Lists task templates for the specified Amazon Connect instance.
listTaskTemplatesRequest - Future<ListTaskTemplatesResult> listTaskTemplatesAsync(ListTaskTemplatesRequest listTaskTemplatesRequest, AsyncHandler<ListTaskTemplatesRequest,ListTaskTemplatesResult> asyncHandler)
Lists task templates for the specified Amazon Connect instance.
listTaskTemplatesRequest - 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.Future<ListTrafficDistributionGroupUsersResult> listTrafficDistributionGroupUsersAsync(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
Lists traffic distribution group users.
listTrafficDistributionGroupUsersRequest - Future<ListTrafficDistributionGroupUsersResult> listTrafficDistributionGroupUsersAsync(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest, AsyncHandler<ListTrafficDistributionGroupUsersRequest,ListTrafficDistributionGroupUsersResult> asyncHandler)
Lists traffic distribution group users.
listTrafficDistributionGroupUsersRequest - 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.Future<ListTrafficDistributionGroupsResult> listTrafficDistributionGroupsAsync(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
Lists traffic distribution groups.
listTrafficDistributionGroupsRequest - Future<ListTrafficDistributionGroupsResult> listTrafficDistributionGroupsAsync(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest, AsyncHandler<ListTrafficDistributionGroupsRequest,ListTrafficDistributionGroupsResult> asyncHandler)
Lists traffic distribution groups.
listTrafficDistributionGroupsRequest - 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.Future<ListUseCasesResult> listUseCasesAsync(ListUseCasesRequest listUseCasesRequest)
Lists the use cases for the integration association.
listUseCasesRequest - Provides summary information about the use cases for the specified integration association.Future<ListUseCasesResult> listUseCasesAsync(ListUseCasesRequest listUseCasesRequest, AsyncHandler<ListUseCasesRequest,ListUseCasesResult> asyncHandler)
Lists the use cases for the integration association.
listUseCasesRequest - 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.Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroupsRequest - Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest, AsyncHandler<ListUserHierarchyGroupsRequest,ListUserHierarchyGroupsResult> asyncHandler)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroupsRequest - 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.Future<ListUserProficienciesResult> listUserProficienciesAsync(ListUserProficienciesRequest listUserProficienciesRequest)
Lists proficiencies associated with a user.
listUserProficienciesRequest - Future<ListUserProficienciesResult> listUserProficienciesAsync(ListUserProficienciesRequest listUserProficienciesRequest, AsyncHandler<ListUserProficienciesRequest,ListUserProficienciesResult> asyncHandler)
Lists proficiencies associated with a user.
listUserProficienciesRequest - 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.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Provides summary information about the users for the specified Amazon Connect instance.
listUsersRequest - Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Provides summary information about the users for the specified Amazon Connect instance.
listUsersRequest - 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.Future<ListViewVersionsResult> listViewVersionsAsync(ListViewVersionsRequest listViewVersionsRequest)
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersionsRequest - Future<ListViewVersionsResult> listViewVersionsAsync(ListViewVersionsRequest listViewVersionsRequest, AsyncHandler<ListViewVersionsRequest,ListViewVersionsResult> asyncHandler)
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersionsRequest - 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.Future<ListViewsResult> listViewsAsync(ListViewsRequest listViewsRequest)
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViewsRequest - Future<ListViewsResult> listViewsAsync(ListViewsRequest listViewsRequest, AsyncHandler<ListViewsRequest,ListViewsResult> asyncHandler)
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViewsRequest - 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.Future<MonitorContactResult> monitorContactAsync(MonitorContactRequest monitorContactRequest)
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
monitorContactRequest - Future<MonitorContactResult> monitorContactAsync(MonitorContactRequest monitorContactRequest, AsyncHandler<MonitorContactRequest,MonitorContactResult> asyncHandler)
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
monitorContactRequest - 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.Future<PauseContactResult> pauseContactAsync(PauseContactRequest pauseContactRequest)
Allows pausing an ongoing task contact.
pauseContactRequest - Future<PauseContactResult> pauseContactAsync(PauseContactRequest pauseContactRequest, AsyncHandler<PauseContactRequest,PauseContactResult> asyncHandler)
Allows pausing an ongoing task contact.
pauseContactRequest - 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.Future<PutUserStatusResult> putUserStatusAsync(PutUserStatusRequest putUserStatusRequest)
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
putUserStatusRequest - Future<PutUserStatusResult> putUserStatusAsync(PutUserStatusRequest putUserStatusRequest, AsyncHandler<PutUserStatusRequest,PutUserStatusResult> asyncHandler)
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
putUserStatusRequest - 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.Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest releasePhoneNumberRequest)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the
Amazon Connect 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.
releasePhoneNumberRequest - Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest releasePhoneNumberRequest, AsyncHandler<ReleasePhoneNumberRequest,ReleasePhoneNumberResult> asyncHandler)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the
Amazon Connect 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.
releasePhoneNumberRequest - 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.Future<ReplicateInstanceResult> replicateInstanceAsync(ReplicateInstanceRequest replicateInstanceRequest)
Replicates 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.
replicateInstanceRequest - Future<ReplicateInstanceResult> replicateInstanceAsync(ReplicateInstanceRequest replicateInstanceRequest, AsyncHandler<ReplicateInstanceRequest,ReplicateInstanceResult> asyncHandler)
Replicates 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.
replicateInstanceRequest - 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.Future<ResumeContactResult> resumeContactAsync(ResumeContactRequest resumeContactRequest)
Allows resuming a task contact in a paused state.
resumeContactRequest - Future<ResumeContactResult> resumeContactAsync(ResumeContactRequest resumeContactRequest, AsyncHandler<ResumeContactRequest,ResumeContactResult> asyncHandler)
Allows resuming a task contact in a paused state.
resumeContactRequest - 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.Future<ResumeContactRecordingResult> resumeContactRecordingAsync(ResumeContactRecordingRequest resumeContactRecordingRequest)
When 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.
resumeContactRecordingRequest - Future<ResumeContactRecordingResult> resumeContactRecordingAsync(ResumeContactRecordingRequest resumeContactRecordingRequest, AsyncHandler<ResumeContactRecordingRequest,ResumeContactRecordingResult> asyncHandler)
When 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.
resumeContactRecordingRequest - 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.Future<SearchAgentStatusesResult> searchAgentStatusesAsync(SearchAgentStatusesRequest searchAgentStatusesRequest)
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatusesRequest - Future<SearchAgentStatusesResult> searchAgentStatusesAsync(SearchAgentStatusesRequest searchAgentStatusesRequest, AsyncHandler<SearchAgentStatusesRequest,SearchAgentStatusesResult> asyncHandler)
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatusesRequest - 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.Future<SearchAvailablePhoneNumbersResult> searchAvailablePhoneNumbersAsync(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group. If the provided TargetArn is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with the traffic distribution group.
searchAvailablePhoneNumbersRequest - Future<SearchAvailablePhoneNumbersResult> searchAvailablePhoneNumbersAsync(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest, AsyncHandler<SearchAvailablePhoneNumbersRequest,SearchAvailablePhoneNumbersResult> asyncHandler)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group. If the provided TargetArn is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with the traffic distribution group.
searchAvailablePhoneNumbersRequest - 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.Future<SearchContactFlowModulesResult> searchContactFlowModulesAsync(SearchContactFlowModulesRequest searchContactFlowModulesRequest)
Searches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModulesRequest - Future<SearchContactFlowModulesResult> searchContactFlowModulesAsync(SearchContactFlowModulesRequest searchContactFlowModulesRequest, AsyncHandler<SearchContactFlowModulesRequest,SearchContactFlowModulesResult> asyncHandler)
Searches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModulesRequest - 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.Future<SearchContactFlowsResult> searchContactFlowsAsync(SearchContactFlowsRequest searchContactFlowsRequest)
Searches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlowsRequest - Future<SearchContactFlowsResult> searchContactFlowsAsync(SearchContactFlowsRequest searchContactFlowsRequest, AsyncHandler<SearchContactFlowsRequest,SearchContactFlowsResult> asyncHandler)
Searches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlowsRequest - 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.Future<SearchContactsResult> searchContactsAsync(SearchContactsRequest searchContactsRequest)
Searches contacts in an Amazon Connect instance.
searchContactsRequest - Future<SearchContactsResult> searchContactsAsync(SearchContactsRequest searchContactsRequest, AsyncHandler<SearchContactsRequest,SearchContactsResult> asyncHandler)
Searches contacts in an Amazon Connect instance.
searchContactsRequest - 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.Future<SearchHoursOfOperationsResult> searchHoursOfOperationsAsync(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsRequest - Future<SearchHoursOfOperationsResult> searchHoursOfOperationsAsync(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest, AsyncHandler<SearchHoursOfOperationsRequest,SearchHoursOfOperationsResult> asyncHandler)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperationsRequest - 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.Future<SearchPredefinedAttributesResult> searchPredefinedAttributesAsync(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest)
Predefined attributes that meet certain criteria.
searchPredefinedAttributesRequest - Future<SearchPredefinedAttributesResult> searchPredefinedAttributesAsync(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest, AsyncHandler<SearchPredefinedAttributesRequest,SearchPredefinedAttributesResult> asyncHandler)
Predefined attributes that meet certain criteria.
searchPredefinedAttributesRequest - 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.Future<SearchPromptsResult> searchPromptsAsync(SearchPromptsRequest searchPromptsRequest)
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsRequest - Future<SearchPromptsResult> searchPromptsAsync(SearchPromptsRequest searchPromptsRequest, AsyncHandler<SearchPromptsRequest,SearchPromptsResult> asyncHandler)
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPromptsRequest - 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.Future<SearchQueuesResult> searchQueuesAsync(SearchQueuesRequest searchQueuesRequest)
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueuesRequest - Future<SearchQueuesResult> searchQueuesAsync(SearchQueuesRequest searchQueuesRequest, AsyncHandler<SearchQueuesRequest,SearchQueuesResult> asyncHandler)
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueuesRequest - 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.Future<SearchQuickConnectsResult> searchQuickConnectsAsync(SearchQuickConnectsRequest searchQuickConnectsRequest)
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsRequest - Future<SearchQuickConnectsResult> searchQuickConnectsAsync(SearchQuickConnectsRequest searchQuickConnectsRequest, AsyncHandler<SearchQuickConnectsRequest,SearchQuickConnectsResult> asyncHandler)
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnectsRequest - 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.Future<SearchResourceTagsResult> searchResourceTagsAsync(SearchResourceTagsRequest searchResourceTagsRequest)
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsRequest - Future<SearchResourceTagsResult> searchResourceTagsAsync(SearchResourceTagsRequest searchResourceTagsRequest, AsyncHandler<SearchResourceTagsRequest,SearchResourceTagsResult> asyncHandler)
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTagsRequest - 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.Future<SearchRoutingProfilesResult> searchRoutingProfilesAsync(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesRequest - Future<SearchRoutingProfilesResult> searchRoutingProfilesAsync(SearchRoutingProfilesRequest searchRoutingProfilesRequest, AsyncHandler<SearchRoutingProfilesRequest,SearchRoutingProfilesResult> asyncHandler)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfilesRequest - 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.Future<SearchSecurityProfilesResult> searchSecurityProfilesAsync(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesRequest - Future<SearchSecurityProfilesResult> searchSecurityProfilesAsync(SearchSecurityProfilesRequest searchSecurityProfilesRequest, AsyncHandler<SearchSecurityProfilesRequest,SearchSecurityProfilesResult> asyncHandler)
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfilesRequest - 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.Future<SearchUserHierarchyGroupsResult> searchUserHierarchyGroupsAsync(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest)
Searches 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.
searchUserHierarchyGroupsRequest - Future<SearchUserHierarchyGroupsResult> searchUserHierarchyGroupsAsync(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest, AsyncHandler<SearchUserHierarchyGroupsRequest,SearchUserHierarchyGroupsResult> asyncHandler)
Searches 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.
searchUserHierarchyGroupsRequest - 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.Future<SearchUsersResult> searchUsersAsync(SearchUsersRequest searchUsersRequest)
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersRequest - Future<SearchUsersResult> searchUsersAsync(SearchUsersRequest searchUsersRequest, AsyncHandler<SearchUsersRequest,SearchUsersResult> asyncHandler)
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
searchUsersRequest - 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.Future<SearchVocabulariesResult> searchVocabulariesAsync(SearchVocabulariesRequest searchVocabulariesRequest)
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabulariesRequest - Future<SearchVocabulariesResult> searchVocabulariesAsync(SearchVocabulariesRequest searchVocabulariesRequest, AsyncHandler<SearchVocabulariesRequest,SearchVocabulariesResult> asyncHandler)
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
searchVocabulariesRequest - 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.Future<SendChatIntegrationEventResult> sendChatIntegrationEventAsync(SendChatIntegrationEventRequest sendChatIntegrationEventRequest)
Processes 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.
sendChatIntegrationEventRequest - Future<SendChatIntegrationEventResult> sendChatIntegrationEventAsync(SendChatIntegrationEventRequest sendChatIntegrationEventRequest, AsyncHandler<SendChatIntegrationEventRequest,SendChatIntegrationEventResult> asyncHandler)
Processes 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.
sendChatIntegrationEventRequest - 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.Future<StartAttachedFileUploadResult> startAttachedFileUploadAsync(StartAttachedFileUploadRequest startAttachedFileUploadRequest)
Provides 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.
startAttachedFileUploadRequest - Future<StartAttachedFileUploadResult> startAttachedFileUploadAsync(StartAttachedFileUploadRequest startAttachedFileUploadRequest, AsyncHandler<StartAttachedFileUploadRequest,StartAttachedFileUploadResult> asyncHandler)
Provides 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.
startAttachedFileUploadRequest - 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.Future<StartChatContactResult> startChatContactAsync(StartChatContactRequest startChatContactRequest)
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for
concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support
the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startChatContactRequest - Future<StartChatContactResult> startChatContactAsync(StartChatContactRequest startChatContactRequest, AsyncHandler<StartChatContactRequest,StartChatContactResult> asyncHandler)
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for
concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support
the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startChatContactRequest - 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.Future<StartContactEvaluationResult> startContactEvaluationAsync(StartContactEvaluationRequest startContactEvaluationRequest)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
startContactEvaluationRequest - Future<StartContactEvaluationResult> startContactEvaluationAsync(StartContactEvaluationRequest startContactEvaluationRequest, AsyncHandler<StartContactEvaluationRequest,StartContactEvaluationResult> asyncHandler)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
startContactEvaluationRequest - 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.Future<StartContactRecordingResult> startContactRecordingAsync(StartContactRecordingRequest startContactRecordingRequest)
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
startContactRecordingRequest - Future<StartContactRecordingResult> startContactRecordingAsync(StartContactRecordingRequest startContactRecordingRequest, AsyncHandler<StartContactRecordingRequest,StartContactRecordingResult> asyncHandler)
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
startContactRecordingRequest - 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.Future<StartContactStreamingResult> startContactStreamingAsync(StartContactStreamingRequest startContactStreamingRequest)
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreamingRequest - Future<StartContactStreamingResult> startContactStreamingAsync(StartContactStreamingRequest startContactStreamingRequest, AsyncHandler<StartContactStreamingRequest,StartContactStreamingResult> asyncHandler)
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreamingRequest - 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.Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's
specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType =
CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.
startOutboundVoiceContactRequest - Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest, AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler)
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's
specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType =
CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.
startOutboundVoiceContactRequest - 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.Future<StartTaskContactResult> startTaskContactAsync(StartTaskContactRequest startTaskContactRequest)
Initiates 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.
startTaskContactRequest - Future<StartTaskContactResult> startTaskContactAsync(StartTaskContactRequest startTaskContactRequest, AsyncHandler<StartTaskContactRequest,StartTaskContactResult> asyncHandler)
Initiates 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.
startTaskContactRequest - 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.Future<StartWebRTCContactResult> startWebRTCContactAsync(StartWebRTCContactRequest startWebRTCContactRequest)
Places 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).
startWebRTCContactRequest - Future<StartWebRTCContactResult> startWebRTCContactAsync(StartWebRTCContactRequest startWebRTCContactRequest, AsyncHandler<StartWebRTCContactRequest,StartWebRTCContactResult> asyncHandler)
Places 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).
startWebRTCContactRequest - 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.Future<StopContactResult> stopContactAsync(StopContactRequest stopContactRequest)
Ends 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.
stopContactRequest - Future<StopContactResult> stopContactAsync(StopContactRequest stopContactRequest, AsyncHandler<StopContactRequest,StopContactResult> asyncHandler)
Ends 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.
stopContactRequest - 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.Future<StopContactRecordingResult> stopContactRecordingAsync(StopContactRecordingRequest stopContactRecordingRequest)
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
stopContactRecordingRequest - Future<StopContactRecordingResult> stopContactRecordingAsync(StopContactRecordingRequest stopContactRecordingRequest, AsyncHandler<StopContactRecordingRequest,StopContactRecordingResult> asyncHandler)
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
stopContactRecordingRequest - 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.Future<StopContactStreamingResult> stopContactStreamingAsync(StopContactStreamingRequest stopContactStreamingRequest)
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingRequest - Future<StopContactStreamingResult> stopContactStreamingAsync(StopContactStreamingRequest stopContactStreamingRequest, AsyncHandler<StopContactStreamingRequest,StopContactStreamingResult> asyncHandler)
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreamingRequest - 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.Future<SubmitContactEvaluationResult> submitContactEvaluationAsync(SubmitContactEvaluationRequest submitContactEvaluationRequest)
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged
with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted
with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
submitContactEvaluationRequest - Future<SubmitContactEvaluationResult> submitContactEvaluationAsync(SubmitContactEvaluationRequest submitContactEvaluationRequest, AsyncHandler<SubmitContactEvaluationRequest,SubmitContactEvaluationResult> asyncHandler)
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged
with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted
with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
submitContactEvaluationRequest - 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.Future<SuspendContactRecordingResult> suspendContactRecordingAsync(SuspendContactRecordingRequest suspendContactRecordingRequest)
When 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.
suspendContactRecordingRequest - Future<SuspendContactRecordingResult> suspendContactRecordingAsync(SuspendContactRecordingRequest suspendContactRecordingRequest, AsyncHandler<SuspendContactRecordingRequest,SuspendContactRecordingResult> asyncHandler)
When 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.
suspendContactRecordingRequest - 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.Future<TagContactResult> tagContactAsync(TagContactRequest tagContactRequest)
Adds 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.
tagContactRequest - Future<TagContactResult> tagContactAsync(TagContactRequest tagContactRequest, AsyncHandler<TagContactRequest,TagContactResult> asyncHandler)
Adds 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.
tagContactRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResourceRequest - 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.Future<TransferContactResult> transferContactAsync(TransferContactRequest transferContactRequest)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
transferContactRequest - Future<TransferContactResult> transferContactAsync(TransferContactRequest transferContactRequest, AsyncHandler<TransferContactRequest,TransferContactResult> asyncHandler)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
transferContactRequest - 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.Future<UntagContactResult> untagContactAsync(UntagContactRequest untagContactRequest)
Removes 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.
untagContactRequest - Future<UntagContactResult> untagContactAsync(UntagContactRequest untagContactRequest, AsyncHandler<UntagContactRequest,UntagContactResult> asyncHandler)
Removes 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.
untagContactRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tags from the specified resource.
untagResourceRequest - 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.Future<UpdateAgentStatusResult> updateAgentStatusAsync(UpdateAgentStatusRequest updateAgentStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusRequest - Future<UpdateAgentStatusResult> updateAgentStatusAsync(UpdateAgentStatusRequest updateAgentStatusRequest, AsyncHandler<UpdateAgentStatusRequest,UpdateAgentStatusResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatusRequest - 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.Future<UpdateAuthenticationProfileResult> updateAuthenticationProfileAsync(UpdateAuthenticationProfileRequest updateAuthenticationProfileRequest)
This 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.
updateAuthenticationProfileRequest - Future<UpdateAuthenticationProfileResult> updateAuthenticationProfileAsync(UpdateAuthenticationProfileRequest updateAuthenticationProfileRequest, AsyncHandler<UpdateAuthenticationProfileRequest,UpdateAuthenticationProfileResult> asyncHandler)
This 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.
updateAuthenticationProfileRequest - 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.Future<UpdateContactResult> updateContactAsync(UpdateContactRequest updateContactRequest)
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
updateContactRequest - Future<UpdateContactResult> updateContactAsync(UpdateContactRequest updateContactRequest, AsyncHandler<UpdateContactRequest,UpdateContactResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
updateContactRequest - 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.Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest)
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
updateContactAttributesRequest - Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest, AsyncHandler<UpdateContactAttributesRequest,UpdateContactAttributesResult> asyncHandler)
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
updateContactAttributesRequest - 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.Future<UpdateContactEvaluationResult> updateContactEvaluationAsync(UpdateContactEvaluationRequest updateContactEvaluationRequest)
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be
in draft state. Answers included in the request are merged with existing answers for the given evaluation. An
answer or note can be deleted by passing an empty object ({}) to the question identifier.
updateContactEvaluationRequest - Future<UpdateContactEvaluationResult> updateContactEvaluationAsync(UpdateContactEvaluationRequest updateContactEvaluationRequest, AsyncHandler<UpdateContactEvaluationRequest,UpdateContactEvaluationResult> asyncHandler)
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be
in draft state. Answers included in the request are merged with existing answers for the given evaluation. An
answer or note can be deleted by passing an empty object ({}) to the question identifier.
updateContactEvaluationRequest - 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.Future<UpdateContactFlowContentResult> updateContactFlowContentAsync(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates 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.
updateContactFlowContentRequest - Future<UpdateContactFlowContentResult> updateContactFlowContentAsync(UpdateContactFlowContentRequest updateContactFlowContentRequest, AsyncHandler<UpdateContactFlowContentRequest,UpdateContactFlowContentResult> asyncHandler)
Updates 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.
updateContactFlowContentRequest - 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.Future<UpdateContactFlowMetadataResult> updateContactFlowMetadataAsync(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
Updates metadata about specified flow.
updateContactFlowMetadataRequest - Future<UpdateContactFlowMetadataResult> updateContactFlowMetadataAsync(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest, AsyncHandler<UpdateContactFlowMetadataRequest,UpdateContactFlowMetadataResult> asyncHandler)
Updates metadata about specified flow.
updateContactFlowMetadataRequest - 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.Future<UpdateContactFlowModuleContentResult> updateContactFlowModuleContentAsync(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
Updates 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.
updateContactFlowModuleContentRequest - Future<UpdateContactFlowModuleContentResult> updateContactFlowModuleContentAsync(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest, AsyncHandler<UpdateContactFlowModuleContentRequest,UpdateContactFlowModuleContentResult> asyncHandler)
Updates 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.
updateContactFlowModuleContentRequest - 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.Future<UpdateContactFlowModuleMetadataResult> updateContactFlowModuleMetadataAsync(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
Updates metadata about specified flow module.
updateContactFlowModuleMetadataRequest - Future<UpdateContactFlowModuleMetadataResult> updateContactFlowModuleMetadataAsync(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest, AsyncHandler<UpdateContactFlowModuleMetadataRequest,UpdateContactFlowModuleMetadataResult> asyncHandler)
Updates metadata about specified flow module.
updateContactFlowModuleMetadataRequest - 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.Future<UpdateContactFlowNameResult> updateContactFlowNameAsync(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameRequest - Future<UpdateContactFlowNameResult> updateContactFlowNameAsync(UpdateContactFlowNameRequest updateContactFlowNameRequest, AsyncHandler<UpdateContactFlowNameRequest,UpdateContactFlowNameResult> asyncHandler)
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowNameRequest - 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.Future<UpdateContactRoutingDataResult> updateContactRoutingDataAsync(UpdateContactRoutingDataRequest updateContactRoutingDataRequest)
Updates 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.
updateContactRoutingDataRequest - Future<UpdateContactRoutingDataResult> updateContactRoutingDataAsync(UpdateContactRoutingDataRequest updateContactRoutingDataRequest, AsyncHandler<UpdateContactRoutingDataRequest,UpdateContactRoutingDataResult> asyncHandler)
Updates 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.
updateContactRoutingDataRequest - 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.Future<UpdateContactScheduleResult> updateContactScheduleAsync(UpdateContactScheduleRequest updateContactScheduleRequest)
Updates the scheduled time of a task contact that is already scheduled.
updateContactScheduleRequest - Future<UpdateContactScheduleResult> updateContactScheduleAsync(UpdateContactScheduleRequest updateContactScheduleRequest, AsyncHandler<UpdateContactScheduleRequest,UpdateContactScheduleResult> asyncHandler)
Updates the scheduled time of a task contact that is already scheduled.
updateContactScheduleRequest - 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.Future<UpdateEvaluationFormResult> updateEvaluationFormAsync(UpdateEvaluationFormRequest updateEvaluationFormRequest)
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
updateEvaluationFormRequest - Future<UpdateEvaluationFormResult> updateEvaluationFormAsync(UpdateEvaluationFormRequest updateEvaluationFormRequest, AsyncHandler<UpdateEvaluationFormRequest,UpdateEvaluationFormResult> asyncHandler)
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
updateEvaluationFormRequest - 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.Future<UpdateHoursOfOperationResult> updateHoursOfOperationAsync(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationRequest - Future<UpdateHoursOfOperationResult> updateHoursOfOperationAsync(UpdateHoursOfOperationRequest updateHoursOfOperationRequest, AsyncHandler<UpdateHoursOfOperationRequest,UpdateHoursOfOperationResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperationRequest - 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.Future<UpdateInstanceAttributeResult> updateInstanceAttributeAsync(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeRequest - Future<UpdateInstanceAttributeResult> updateInstanceAttributeAsync(UpdateInstanceAttributeRequest updateInstanceAttributeRequest, AsyncHandler<UpdateInstanceAttributeRequest,UpdateInstanceAttributeResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeRequest - 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.Future<UpdateInstanceStorageConfigResult> updateInstanceStorageConfigAsync(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfigRequest - Future<UpdateInstanceStorageConfigResult> updateInstanceStorageConfigAsync(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest, AsyncHandler<UpdateInstanceStorageConfigRequest,UpdateInstanceStorageConfigResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfigRequest - 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.Future<UpdateParticipantRoleConfigResult> updateParticipantRoleConfigAsync(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
updateParticipantRoleConfigRequest - Future<UpdateParticipantRoleConfigResult> updateParticipantRoleConfigAsync(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest, AsyncHandler<UpdateParticipantRoleConfigRequest,UpdateParticipantRoleConfigResult> asyncHandler)
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
updateParticipantRoleConfigRequest - 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.Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumberRequest - Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest updatePhoneNumberRequest, AsyncHandler<UpdatePhoneNumberRequest,UpdatePhoneNumberResult> asyncHandler)
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumberRequest - 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.Future<UpdatePhoneNumberMetadataResult> updatePhoneNumberMetadataAsync(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest)
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadataRequest - Future<UpdatePhoneNumberMetadataResult> updatePhoneNumberMetadataAsync(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest, AsyncHandler<UpdatePhoneNumberMetadataRequest,UpdatePhoneNumberMetadataResult> asyncHandler)
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadataRequest - 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.Future<UpdatePredefinedAttributeResult> updatePredefinedAttributeAsync(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest)
Updates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttributeRequest - Future<UpdatePredefinedAttributeResult> updatePredefinedAttributeAsync(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest, AsyncHandler<UpdatePredefinedAttributeRequest,UpdatePredefinedAttributeResult> asyncHandler)
Updates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttributeRequest - 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.Future<UpdatePromptResult> updatePromptAsync(UpdatePromptRequest updatePromptRequest)
Updates a prompt.
updatePromptRequest - Future<UpdatePromptResult> updatePromptAsync(UpdatePromptRequest updatePromptRequest, AsyncHandler<UpdatePromptRequest,UpdatePromptResult> asyncHandler)
Updates a prompt.
updatePromptRequest - 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.Future<UpdateQueueHoursOfOperationResult> updateQueueHoursOfOperationAsync(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationRequest - Future<UpdateQueueHoursOfOperationResult> updateQueueHoursOfOperationAsync(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest, AsyncHandler<UpdateQueueHoursOfOperationRequest,UpdateQueueHoursOfOperationResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperationRequest - 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.Future<UpdateQueueMaxContactsResult> updateQueueMaxContactsAsync(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
updateQueueMaxContactsRequest - Future<UpdateQueueMaxContactsResult> updateQueueMaxContactsAsync(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest, AsyncHandler<UpdateQueueMaxContactsRequest,UpdateQueueMaxContactsResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
updateQueueMaxContactsRequest - 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.Future<UpdateQueueNameResult> updateQueueNameAsync(UpdateQueueNameRequest updateQueueNameRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name or Description must be
provided.
updateQueueNameRequest - Future<UpdateQueueNameResult> updateQueueNameAsync(UpdateQueueNameRequest updateQueueNameRequest, AsyncHandler<UpdateQueueNameRequest,UpdateQueueNameResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name or Description must be
provided.
updateQueueNameRequest - 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.Future<UpdateQueueOutboundCallerConfigResult> updateQueueOutboundCallerConfigAsync(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the 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.
updateQueueOutboundCallerConfigRequest - Future<UpdateQueueOutboundCallerConfigResult> updateQueueOutboundCallerConfigAsync(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest, AsyncHandler<UpdateQueueOutboundCallerConfigRequest,UpdateQueueOutboundCallerConfigResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the 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.
updateQueueOutboundCallerConfigRequest - 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.Future<UpdateQueueStatusResult> updateQueueStatusAsync(UpdateQueueStatusRequest updateQueueStatusRequest)
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusRequest - Future<UpdateQueueStatusResult> updateQueueStatusAsync(UpdateQueueStatusRequest updateQueueStatusRequest, AsyncHandler<UpdateQueueStatusRequest,UpdateQueueStatusResult> asyncHandler)
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatusRequest - 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.Future<UpdateQuickConnectConfigResult> updateQuickConnectConfigAsync(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfigRequest - Future<UpdateQuickConnectConfigResult> updateQuickConnectConfigAsync(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest, AsyncHandler<UpdateQuickConnectConfigRequest,UpdateQuickConnectConfigResult> asyncHandler)
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfigRequest - 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.Future<UpdateQuickConnectNameResult> updateQuickConnectNameAsync(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At
least Name or Description must be provided.
updateQuickConnectNameRequest - Future<UpdateQuickConnectNameResult> updateQuickConnectNameAsync(UpdateQuickConnectNameRequest updateQuickConnectNameRequest, AsyncHandler<UpdateQuickConnectNameRequest,UpdateQuickConnectNameResult> asyncHandler)
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At
least Name or Description must be provided.
updateQuickConnectNameRequest - 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.Future<UpdateRoutingProfileAgentAvailabilityTimerResult> updateRoutingProfileAgentAvailabilityTimerAsync(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerRequest - Future<UpdateRoutingProfileAgentAvailabilityTimerResult> updateRoutingProfileAgentAvailabilityTimerAsync(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest, AsyncHandler<UpdateRoutingProfileAgentAvailabilityTimerRequest,UpdateRoutingProfileAgentAvailabilityTimerResult> asyncHandler)
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimerRequest - 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.Future<UpdateRoutingProfileConcurrencyResult> updateRoutingProfileConcurrencyAsync(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyRequest - Future<UpdateRoutingProfileConcurrencyResult> updateRoutingProfileConcurrencyAsync(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest, AsyncHandler<UpdateRoutingProfileConcurrencyRequest,UpdateRoutingProfileConcurrencyResult> asyncHandler)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyRequest - 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.Future<UpdateRoutingProfileDefaultOutboundQueueResult> updateRoutingProfileDefaultOutboundQueueAsync(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueRequest - Future<UpdateRoutingProfileDefaultOutboundQueueResult> updateRoutingProfileDefaultOutboundQueueAsync(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest, AsyncHandler<UpdateRoutingProfileDefaultOutboundQueueRequest,UpdateRoutingProfileDefaultOutboundQueueResult> asyncHandler)
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueRequest - 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.Future<UpdateRoutingProfileNameResult> updateRoutingProfileNameAsync(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At
least Name or Description must be provided.
updateRoutingProfileNameRequest - Future<UpdateRoutingProfileNameResult> updateRoutingProfileNameAsync(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest, AsyncHandler<UpdateRoutingProfileNameRequest,UpdateRoutingProfileNameResult> asyncHandler)
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At
least Name or Description must be provided.
updateRoutingProfileNameRequest - 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.Future<UpdateRoutingProfileQueuesResult> updateRoutingProfileQueuesAsync(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesRequest - Future<UpdateRoutingProfileQueuesResult> updateRoutingProfileQueuesAsync(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest, AsyncHandler<UpdateRoutingProfileQueuesRequest,UpdateRoutingProfileQueuesResult> asyncHandler)
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesRequest - 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.Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest updateRuleRequest)
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleRequest - Future<UpdateRuleResult> updateRuleAsync(UpdateRuleRequest updateRuleRequest, AsyncHandler<UpdateRuleRequest,UpdateRuleResult> asyncHandler)
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRuleRequest - 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.Future<UpdateSecurityProfileResult> updateSecurityProfileAsync(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a security profile.
updateSecurityProfileRequest - Future<UpdateSecurityProfileResult> updateSecurityProfileAsync(UpdateSecurityProfileRequest updateSecurityProfileRequest, AsyncHandler<UpdateSecurityProfileRequest,UpdateSecurityProfileResult> asyncHandler)
Updates a security profile.
updateSecurityProfileRequest - 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.Future<UpdateTaskTemplateResult> updateTaskTemplateAsync(UpdateTaskTemplateRequest updateTaskTemplateRequest)
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
updateTaskTemplateRequest - Future<UpdateTaskTemplateResult> updateTaskTemplateAsync(UpdateTaskTemplateRequest updateTaskTemplateRequest, AsyncHandler<UpdateTaskTemplateRequest,UpdateTaskTemplateResult> asyncHandler)
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
updateTaskTemplateRequest - 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.Future<UpdateTrafficDistributionResult> updateTrafficDistributionAsync(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)
Updates 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.
updateTrafficDistributionRequest - Future<UpdateTrafficDistributionResult> updateTrafficDistributionAsync(UpdateTrafficDistributionRequest updateTrafficDistributionRequest, AsyncHandler<UpdateTrafficDistributionRequest,UpdateTrafficDistributionResult> asyncHandler)
Updates 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.
updateTrafficDistributionRequest - 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.Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchyRequest - Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest, AsyncHandler<UpdateUserHierarchyRequest,UpdateUserHierarchyResult> asyncHandler)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchyRequest - 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.Future<UpdateUserHierarchyGroupNameResult> updateUserHierarchyGroupNameAsync(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
Updates the name of the user hierarchy group.
updateUserHierarchyGroupNameRequest - Future<UpdateUserHierarchyGroupNameResult> updateUserHierarchyGroupNameAsync(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest, AsyncHandler<UpdateUserHierarchyGroupNameRequest,UpdateUserHierarchyGroupNameResult> asyncHandler)
Updates the name of the user hierarchy group.
updateUserHierarchyGroupNameRequest - 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.Future<UpdateUserHierarchyStructureResult> updateUserHierarchyStructureAsync(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureRequest - Future<UpdateUserHierarchyStructureResult> updateUserHierarchyStructureAsync(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest, AsyncHandler<UpdateUserHierarchyStructureRequest,UpdateUserHierarchyStructureResult> asyncHandler)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureRequest - 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.Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with
that ability can change the login credentials of other users by changing their email address. This poses a
security risk to your organization. They can change the email address of a user to the attacker's email address,
and then reset the password through email. For more information, see Best Practices
for Security Profiles in the Amazon Connect Administrator Guide.
updateUserIdentityInfoRequest - Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest, AsyncHandler<UpdateUserIdentityInfoRequest,UpdateUserIdentityInfoResult> asyncHandler)
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with
that ability can change the login credentials of other users by changing their email address. This poses a
security risk to your organization. They can change the email address of a user to the attacker's email address,
and then reset the password through email. For more information, see Best Practices
for Security Profiles in the Amazon Connect Administrator Guide.
updateUserIdentityInfoRequest - 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.Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfigRequest - Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest, AsyncHandler<UpdateUserPhoneConfigRequest,UpdateUserPhoneConfigResult> asyncHandler)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfigRequest - 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.Future<UpdateUserProficienciesResult> updateUserProficienciesAsync(UpdateUserProficienciesRequest updateUserProficienciesRequest)
Updates the properties associated with the proficiencies of a user.
updateUserProficienciesRequest - Future<UpdateUserProficienciesResult> updateUserProficienciesAsync(UpdateUserProficienciesRequest updateUserProficienciesRequest, AsyncHandler<UpdateUserProficienciesRequest,UpdateUserProficienciesResult> asyncHandler)
Updates the properties associated with the proficiencies of a user.
updateUserProficienciesRequest - 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.Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfileRequest - Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest, AsyncHandler<UpdateUserRoutingProfileRequest,UpdateUserRoutingProfileResult> asyncHandler)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfileRequest - 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.Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfilesRequest - Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest, AsyncHandler<UpdateUserSecurityProfilesRequest,UpdateUserSecurityProfilesResult> asyncHandler)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfilesRequest - 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.Future<UpdateViewContentResult> updateViewContentAsync(UpdateViewContentRequest updateViewContentRequest)
Updates 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.
updateViewContentRequest - Future<UpdateViewContentResult> updateViewContentAsync(UpdateViewContentRequest updateViewContentRequest, AsyncHandler<UpdateViewContentRequest,UpdateViewContentResult> asyncHandler)
Updates 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.
updateViewContentRequest - 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.Future<UpdateViewMetadataResult> updateViewMetadataAsync(UpdateViewMetadataRequest updateViewMetadataRequest)
Updates the view metadata. Note that either Name or Description must be provided.
updateViewMetadataRequest - Future<UpdateViewMetadataResult> updateViewMetadataAsync(UpdateViewMetadataRequest updateViewMetadataRequest, AsyncHandler<UpdateViewMetadataRequest,UpdateViewMetadataResult> asyncHandler)
Updates the view metadata. Note that either Name or Description must be provided.
updateViewMetadataRequest - 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.