@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