/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.connect.model.*; /** * Interface for accessing Amazon Connect *

* 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. *

**/ public interface AmazonConnect { /** * Overrides the default endpoint for this client * ("https://connect.us-east-1.amazonaws.com"). Callers can use this method * to control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: * "connect.us-east-1.amazonaws.com") or a full URL, including the protocol * (ex: "https://connect.us-east-1.amazonaws.com"). If the protocol is not * specified here, the default protocol from this client's * {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and * a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *

* This method is not threadsafe. An endpoint should be configured when * the client is created and before any service requests are made. Changing * it afterwards creates inevitable race conditions for any service requests * in transit or retrying. * * @param endpoint The endpoint (ex: "connect.us-east-1.amazonaws.com") or a * full URL, including the protocol (ex: * "https://connect.us-east-1.amazonaws.com") of the region * specific AWS endpoint this client will communicate with. * @throws IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AmazonConnect#setEndpoint(String)}, sets the * regional endpoint for this client's service calls. Callers can use this * method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. *

* This method is not threadsafe. A region should be configured when the * client is created and before any service requests are made. Changing it * afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *

* 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. *

* * @param activateEvaluationFormRequest * @return activateEvaluationFormResult The response from the * ActivateEvaluationForm service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ActivateEvaluationFormResult activateEvaluationForm( ActivateEvaluationFormRequest activateEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Associates an approved origin to an Amazon Connect instance. *

* * @param associateApprovedOriginRequest * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param associateBotRequest * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws LimitExceededException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateBot(AssociateBotRequest associateBotRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param associateDefaultVocabularyRequest * @return associateDefaultVocabularyResult The response from the * AssociateDefaultVocabulary service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ AssociateDefaultVocabularyResult associateDefaultVocabulary( AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param associateInstanceStorageConfigRequest * @return associateInstanceStorageConfigResult The response from the * AssociateInstanceStorageConfig service method, as returned by * Amazon Connect. * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ AssociateInstanceStorageConfigResult associateInstanceStorageConfig( AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param associateLambdaFunctionRequest * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param associateLexBotRequest * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateLexBot(AssociateLexBotRequest associateLexBotRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param associatePhoneNumberContactFlowRequest * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associatePhoneNumberContactFlow( AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Associates a set of quick connects with a queue. *

* * @param associateQueueQuickConnectsRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateQueueQuickConnects( AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Associates a set of queues with a routing profile. *

* * @param associateRoutingProfileQueuesRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void associateRoutingProfileQueues( AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Associates a security key to the instance. *

* * @param associateSecurityKeyRequest * @return associateSecurityKeyResult The response from the * AssociateSecurityKey service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ AssociateSecurityKeyResult associateSecurityKey( AssociateSecurityKeyRequest associateSecurityKeyRequest) throws AmazonClientException, AmazonServiceException; /** *

* Claims an available phone number to your Amazon Connect instance or * traffic distribution group. You can call this API only in the same Amazon * Web Services Region where the Amazon Connect instance or traffic * distribution group was created. *

*

* For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon * Connect Administrator Guide. *

* *

* You can call the SearchAvailablePhoneNumbers API for available phone numbers that you * can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. *

*
*

* If you plan to claim and release numbers frequently during a 30 day * period, contact us for a service quota exception. Otherwise, it is * possible you will be blocked from claiming and releasing any more numbers * until 30 days past the oldest number released has expired. *

*

* By default you can claim and release up to 200% of your maximum number of * active phone numbers during any 30 day period. If you claim and release * phone numbers using the UI or API during a rolling 30 day cycle that * exceeds 200% of your phone number service level quota, you will be * blocked from claiming any more numbers until 30 days past the oldest * number released has expired. *

*

* For example, if you already have 99 claimed numbers and a service level * quota of 99 phone numbers, and in any 30 day period you release 99, claim * 99, and then release 99, you will have exceeded the 200% limit. At that * point you are blocked from claiming any more numbers until you open an * Amazon Web Services support ticket. *

* * @param claimPhoneNumberRequest * @return claimPhoneNumberResult The response from the ClaimPhoneNumber * service method, as returned by Amazon Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws IdempotencyException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Creates an agent status for the specified Amazon Connect instance. *

* * @param createAgentStatusRequest * @return createAgentStatusResult The response from the CreateAgentStatus * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a flow for the specified Amazon Connect instance. *

*

* You can also create and update flows using the Amazon Connect Flow language. *

* * @param createContactFlowRequest * @return createContactFlowResult The response from the CreateContactFlow * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidContactFlowException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws LimitExceededException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a flow module for the specified Amazon Connect instance. *

* * @param createContactFlowModuleRequest * @return createContactFlowModuleResult The response from the * CreateContactFlowModule service method, as returned by Amazon * Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidContactFlowModuleException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws LimitExceededException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws IdempotencyException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateContactFlowModuleResult createContactFlowModule( CreateContactFlowModuleRequest createContactFlowModuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param createEvaluationFormRequest * @return createEvaluationFormResult The response from the * CreateEvaluationForm service method, as returned by Amazon * Connect. * @throws InternalServiceException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceQuotaExceededException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateEvaluationFormResult createEvaluationForm( CreateEvaluationFormRequest createEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Creates hours of operation. *

* * @param createHoursOfOperationRequest * @return createHoursOfOperationResult The response from the * CreateHoursOfOperation service method, as returned by Amazon * Connect. * @throws DuplicateResourceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateHoursOfOperationResult createHoursOfOperation( CreateHoursOfOperationRequest createHoursOfOperationRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param createInstanceRequest * @return createInstanceResult The response from the CreateInstance service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates an Amazon Web Services resource association with an Amazon * Connect instance. *

* * @param createIntegrationAssociationRequest * @return createIntegrationAssociationResult The response from the * CreateIntegrationAssociation service method, as returned by * Amazon Connect. * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateIntegrationAssociationResult createIntegrationAssociation( CreateIntegrationAssociationRequest createIntegrationAssociationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Adds a new participant into an on-going chat contact. For more * information, see Customize chat flow experiences by integrating custom participants. *

* * @param createParticipantRequest * @return createParticipantResult The response from the CreateParticipant * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateParticipantResult createParticipant(CreateParticipantRequest createParticipantRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a prompt. For more information about prompts, such as supported * file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide. *

* * @param createPromptRequest * @return createPromptResult The response from the CreatePrompt service * method, as returned by Amazon Connect. * @throws DuplicateResourceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreatePromptResult createPrompt(CreatePromptRequest createPromptRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Creates a new queue for the specified Amazon Connect instance. *

* *

* If the number being used in the input is claimed to a traffic * distribution group, and you are calling this API using an instance in the * Amazon Web Services Region where the traffic distribution group was * created, you can use either a full phone number ARN or UUID value for the * OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number * is claimed to a traffic distribution group and you are calling this API * using an instance in the alternate Amazon Web Services Region associated * with the traffic distribution group, you must provide a full phone number * ARN. If a UUID is provided in this scenario, you will receive a * ResourceNotFoundException. *

*
* * @param createQueueRequest * @return createQueueResult The response from the CreateQueue service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateQueueResult createQueue(CreateQueueRequest createQueueRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a quick connect for the specified Amazon Connect instance. *

* * @param createQuickConnectRequest * @return createQuickConnectResult The response from the CreateQuickConnect * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a new routing profile. *

* * @param createRoutingProfileRequest * @return createRoutingProfileResult The response from the * CreateRoutingProfile service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateRoutingProfileResult createRoutingProfile( CreateRoutingProfileRequest createRoutingProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a rule for the specified Amazon Connect instance. *

*

* Use the Rules Function language to code conditions for the rule. *

* * @param createRuleRequest * @return createRuleResult The response from the CreateRule service method, * as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws ResourceConflictException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateRuleResult createRule(CreateRuleRequest createRuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Creates a security profile. *

* * @param createSecurityProfileRequest * @return createSecurityProfileResult The response from the * CreateSecurityProfile service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws LimitExceededException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateSecurityProfileResult createSecurityProfile( CreateSecurityProfileRequest createSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a new task template in the specified Amazon Connect instance. *

* * @param createTaskTemplateRequest * @return createTaskTemplateResult The response from the CreateTaskTemplate * service method, as returned by Amazon Connect. * @throws PropertyValidationException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceQuotaExceededException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a traffic distribution group given an Amazon Connect instance * that has been replicated. *

*

* For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect * Administrator Guide. *

* * @param createTrafficDistributionGroupRequest * @return createTrafficDistributionGroupResult The response from the * CreateTrafficDistributionGroup service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ResourceConflictException * @throws ResourceNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateTrafficDistributionGroupResult createTrafficDistributionGroup( CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a use case for an integration association. *

* * @param createUseCaseRequest * @return createUseCaseResult The response from the CreateUseCase service * method, as returned by Amazon Connect. * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a user account for the specified Amazon Connect instance. *

*

* For information about how to create user accounts using the Amazon * Connect console, see Add Users in the Amazon Connect Administrator Guide. *

* * @param createUserRequest * @return createUserResult The response from the CreateUser service method, * as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws LimitExceededException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateUserResult createUser(CreateUserRequest createUserRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a new user hierarchy group. *

* * @param createUserHierarchyGroupRequest * @return createUserHierarchyGroupResult The response from the * CreateUserHierarchyGroup service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws LimitExceededException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateUserHierarchyGroupResult createUserHierarchyGroup( CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param createVocabularyRequest * @return createVocabularyResult The response from the CreateVocabulary * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws ResourceConflictException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param deactivateEvaluationFormRequest * @return deactivateEvaluationFormResult The response from the * DeactivateEvaluationForm service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeactivateEvaluationFormResult deactivateEvaluationForm( DeactivateEvaluationFormRequest deactivateEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a contact evaluation in the specified Amazon Connect instance. *

* * @param deleteContactEvaluationRequest * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a flow for the specified Amazon Connect instance. *

* * @param deleteContactFlowRequest * @return deleteContactFlowResult The response from the DeleteContactFlow * service method, as returned by Amazon Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes the specified flow module. *

* * @param deleteContactFlowModuleRequest * @return deleteContactFlowModuleResult The response from the * DeleteContactFlowModule service method, as returned by Amazon * Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeleteContactFlowModuleResult deleteContactFlowModule( DeleteContactFlowModuleRequest deleteContactFlowModuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes an evaluation form in the specified Amazon Connect instance. *

* * * @param deleteEvaluationFormRequest * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Deletes an hours of operation. *

* * @param deleteHoursOfOperationRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param deleteInstanceRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes an Amazon Web Services resource association from an Amazon * Connect instance. The association must not have any use cases associated * with it. *

* * @param deleteIntegrationAssociationRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteIntegrationAssociation( DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a prompt. *

* * @param deletePromptRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deletePrompt(DeletePromptRequest deletePromptRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a quick connect. *

* * @param deleteQuickConnectRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a rule for the specified Amazon Connect instance. *

* * @param deleteRuleRequest * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteRule(DeleteRuleRequest deleteRuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Deletes a security profile. *

* * @param deleteSecurityProfileRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws ResourceInUseException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes the task template. *

* * @param deleteTaskTemplateRequest * @return deleteTaskTemplateResult The response from the DeleteTaskTemplate * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param deleteTrafficDistributionGroupRequest * @return deleteTrafficDistributionGroupResult The response from the * DeleteTrafficDistributionGroup service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ResourceInUseException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup( DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes a use case from an integration association. *

* * @param deleteUseCaseRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param deleteUserRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes an existing user hierarchy group. It must not be associated with * any agents or have any active child groups. *

* * @param deleteUserHierarchyGroupRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ResourceInUseException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* Deletes the vocabulary that has the given identifier. *

* * @param deleteVocabularyRequest * @return deleteVocabularyResult The response from the DeleteVocabulary * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws ResourceInUseException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Describes an agent status. *

* * @param describeAgentStatusRequest * @return describeAgentStatusResult The response from the * DescribeAgentStatus service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeAgentStatusResult describeAgentStatus( DescribeAgentStatusRequest describeAgentStatusRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param describeContactRequest * @return describeContactResult The response from the DescribeContact * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeContactResult describeContact(DescribeContactRequest describeContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes a contact evaluation in the specified Amazon Connect instance. *

* * @param describeContactEvaluationRequest * @return describeContactEvaluationResult The response from the * DescribeContactEvaluation service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeContactEvaluationResult describeContactEvaluation( DescribeContactEvaluationRequest describeContactEvaluationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified flow. *

*

* You can also create and update flows using the Amazon Connect Flow language. *

* * @param describeContactFlowRequest * @return describeContactFlowResult The response from the * DescribeContactFlow service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ContactFlowNotPublishedException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeContactFlowResult describeContactFlow( DescribeContactFlowRequest describeContactFlowRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified flow module. *

* * @param describeContactFlowModuleRequest * @return describeContactFlowModuleResult The response from the * DescribeContactFlowModule service method, as returned by Amazon * Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeContactFlowModuleResult describeContactFlowModule( DescribeContactFlowModuleRequest describeContactFlowModuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param describeEvaluationFormRequest * @return describeEvaluationFormResult The response from the * DescribeEvaluationForm service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeEvaluationFormResult describeEvaluationForm( DescribeEvaluationFormRequest describeEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Describes the hours of operation. *

* * @param describeHoursOfOperationRequest * @return describeHoursOfOperationResult The response from the * DescribeHoursOfOperation service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeHoursOfOperationResult describeHoursOfOperation( DescribeHoursOfOperationRequest describeHoursOfOperationRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param describeInstanceRequest * @return describeInstanceResult The response from the DescribeInstance * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Describes the specified instance attribute. *

* * @param describeInstanceAttributeRequest * @return describeInstanceAttributeResult The response from the * DescribeInstanceAttribute service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeInstanceAttributeResult describeInstanceAttribute( DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param describeInstanceStorageConfigRequest * @return describeInstanceStorageConfigResult The response from the * DescribeInstanceStorageConfig service method, as returned by * Amazon Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeInstanceStorageConfigResult describeInstanceStorageConfig( DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param describePhoneNumberRequest * @return describePhoneNumberResult The response from the * DescribePhoneNumber service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribePhoneNumberResult describePhoneNumber( DescribePhoneNumberRequest describePhoneNumberRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the prompt. *

* * @param describePromptRequest * @return describePromptResult The response from the DescribePrompt service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribePromptResult describePrompt(DescribePromptRequest describePromptRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Describes the specified queue. *

* * @param describeQueueRequest * @return describeQueueResult The response from the DescribeQueue service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeQueueResult describeQueue(DescribeQueueRequest describeQueueRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the quick connect. *

* * @param describeQuickConnectRequest * @return describeQuickConnectResult The response from the * DescribeQuickConnect service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeQuickConnectResult describeQuickConnect( DescribeQuickConnectRequest describeQuickConnectRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified routing profile. *

* * @param describeRoutingProfileRequest * @return describeRoutingProfileResult The response from the * DescribeRoutingProfile service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeRoutingProfileResult describeRoutingProfile( DescribeRoutingProfileRequest describeRoutingProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes a rule for the specified Amazon Connect instance. *

* * @param describeRuleRequest * @return describeRuleResult The response from the DescribeRule service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Gets basic information about the security profle. *

* * @param describeSecurityProfileRequest * @return describeSecurityProfileResult The response from the * DescribeSecurityProfile service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeSecurityProfileResult describeSecurityProfile( DescribeSecurityProfileRequest describeSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Gets details and status of a traffic distribution group. *

* * @param describeTrafficDistributionGroupRequest * @return describeTrafficDistributionGroupResult The response from the * DescribeTrafficDistributionGroup service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup( DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final * part of the ARN). The console does not display the user IDs. Instead, * list the users and note the IDs provided in the output. *

* * @param describeUserRequest * @return describeUserResult The response from the DescribeUser service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeUserResult describeUser(DescribeUserRequest describeUserRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified hierarchy group. *

* * @param describeUserHierarchyGroupRequest * @return describeUserHierarchyGroupResult The response from the * DescribeUserHierarchyGroup service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeUserHierarchyGroupResult describeUserHierarchyGroup( DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the hierarchy structure of the specified Amazon Connect * instance. *

* * @param describeUserHierarchyStructureRequest * @return describeUserHierarchyStructureResult The response from the * DescribeUserHierarchyStructure service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeUserHierarchyStructureResult describeUserHierarchyStructure( DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) throws AmazonClientException, AmazonServiceException; /** *

* Describes the specified vocabulary. *

* * @param describeVocabularyRequest * @return describeVocabularyResult The response from the DescribeVocabulary * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Revokes access to integrated applications from Amazon Connect. *

* * @param disassociateApprovedOriginRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateApprovedOrigin( DisassociateApprovedOriginRequest disassociateApprovedOriginRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param disassociateBotRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateBot(DisassociateBotRequest disassociateBotRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param disassociateInstanceStorageConfigRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateInstanceStorageConfig( DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param disassociateLambdaFunctionRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateLambdaFunction( DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param disassociateLexBotRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param disassociatePhoneNumberContactFlowRequest * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociatePhoneNumberContactFlow( DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Disassociates a set of quick connects from a queue. *

* * @param disassociateQueueQuickConnectsRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateQueueQuickConnects( DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Disassociates a set of queues from a routing profile. *

* * @param disassociateRoutingProfileQueuesRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateRoutingProfileQueues( DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Deletes the specified security key. *

* * @param disassociateSecurityKeyRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param dismissUserContactRequest * @return dismissUserContactResult The response from the DismissUserContact * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AccessDeniedException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ DismissUserContactResult dismissUserContact(DismissUserContactRequest dismissUserContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* Retrieves the contact attributes for the specified contact. *

* * @param getContactAttributesRequest * @return getContactAttributesResult The response from the * GetContactAttributes service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetContactAttributesResult getContactAttributes( GetContactAttributesRequest getContactAttributesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param getCurrentMetricDataRequest * @return getCurrentMetricDataResult The response from the * GetCurrentMetricData service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetCurrentMetricDataResult getCurrentMetricData( GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws AmazonClientException, AmazonServiceException; /** *

* Gets the real-time active user data from the specified Amazon Connect * instance. *

* * @param getCurrentUserDataRequest * @return getCurrentUserDataResult The response from the GetCurrentUserData * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest) throws AmazonClientException, AmazonServiceException; /** *

* Retrieves a token for federation. *

* *

* This API doesn't support root users. If you try to invoke * GetFederationToken with root credentials, an error message similar to the * following one appears: *

*

* Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect *

*
* * @param getFederationTokenRequest * @return getFederationTokenResult The response from the GetFederationToken * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws UserNotFoundException * @throws InternalServiceException * @throws DuplicateResourceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param getMetricDataRequest * @return getMetricDataResult The response from the GetMetricData service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest) throws AmazonClientException, AmazonServiceException; /** *

* Gets metric data from the specified Amazon Connect instance. *

*

* GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, * offers filtering at a metric level, and offers the ability to filter and * group data by channels, queues, routing profiles, agents, and agent * hierarchy levels. It can retrieve historical data for the last 35 days, * in 24-hour intervals. *

*

* For a description of the historical metrics that are supported by * GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

* * @param getMetricDataV2Request * @return getMetricDataV2Result The response from the GetMetricDataV2 * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetMetricDataV2Result getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request) throws AmazonClientException, AmazonServiceException; /** *

* Gets the prompt file. *

* * @param getPromptFileRequest * @return getPromptFileResult The response from the GetPromptFile service * method, as returned by Amazon Connect. * @throws InvalidParameterException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetPromptFileResult getPromptFile(GetPromptFileRequest getPromptFileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Gets details about a specific task template in the specified Amazon * Connect instance. *

* * @param getTaskTemplateRequest * @return getTaskTemplateResult The response from the GetTaskTemplate * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *

* Retrieves the current traffic distribution for a given traffic * distribution group. *

* * @param getTrafficDistributionRequest * @return getTrafficDistributionResult The response from the * GetTrafficDistribution service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ GetTrafficDistributionResult getTrafficDistribution( GetTrafficDistributionRequest getTrafficDistributionRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Lists agent statuses. *

* * @param listAgentStatusesRequest * @return listAgentStatusesResult The response from the ListAgentStatuses * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listApprovedOriginsRequest * @return listApprovedOriginsResult The response from the * ListApprovedOrigins service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListApprovedOriginsResult listApprovedOrigins( ListApprovedOriginsRequest listApprovedOriginsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listBotsRequest * @return listBotsResult The response from the ListBots service method, as * returned by Amazon Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListBotsResult listBots(ListBotsRequest listBotsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists contact evaluations in the specified Amazon Connect instance. *

* * @param listContactEvaluationsRequest * @return listContactEvaluationsResult The response from the * ListContactEvaluations service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListContactEvaluationsResult listContactEvaluations( ListContactEvaluationsRequest listContactEvaluationsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the flow modules for the specified Amazon * Connect instance. *

* * @param listContactFlowModulesRequest * @return listContactFlowModulesResult The response from the * ListContactFlowModules service method, as returned by Amazon * Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListContactFlowModulesResult listContactFlowModules( ListContactFlowModulesRequest listContactFlowModulesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listContactFlowsRequest * @return listContactFlowsResult The response from the ListContactFlows * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listContactReferencesRequest * @return listContactReferencesResult The response from the * ListContactReferences service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListContactReferencesResult listContactReferences( ListContactReferencesRequest listContactReferencesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists the default vocabularies for the specified Amazon Connect instance. *

* * @param listDefaultVocabulariesRequest * @return listDefaultVocabulariesResult The response from the * ListDefaultVocabularies service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListDefaultVocabulariesResult listDefaultVocabularies( ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists versions of an evaluation form in the specified Amazon Connect * instance. *

* * @param listEvaluationFormVersionsRequest * @return listEvaluationFormVersionsResult The response from the * ListEvaluationFormVersions service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListEvaluationFormVersionsResult listEvaluationFormVersions( ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists evaluation forms in the specified Amazon Connect instance. *

* * @param listEvaluationFormsRequest * @return listEvaluationFormsResult The response from the * ListEvaluationForms service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListEvaluationFormsResult listEvaluationForms( ListEvaluationFormsRequest listEvaluationFormsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listHoursOfOperationsRequest * @return listHoursOfOperationsResult The response from the * ListHoursOfOperations service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListHoursOfOperationsResult listHoursOfOperations( ListHoursOfOperationsRequest listHoursOfOperationsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listInstanceAttributesRequest * @return listInstanceAttributesResult The response from the * ListInstanceAttributes service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListInstanceAttributesResult listInstanceAttributes( ListInstanceAttributesRequest listInstanceAttributesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listInstanceStorageConfigsRequest * @return listInstanceStorageConfigsResult The response from the * ListInstanceStorageConfigs service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListInstanceStorageConfigsResult listInstanceStorageConfigs( ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listInstancesRequest * @return listInstancesResult The response from the ListInstances service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides summary information about the Amazon Web Services resource * associations for the specified Amazon Connect instance. *

* * @param listIntegrationAssociationsRequest * @return listIntegrationAssociationsResult The response from the * ListIntegrationAssociations service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListIntegrationAssociationsResult listIntegrationAssociations( ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listLambdaFunctionsRequest * @return listLambdaFunctionsResult The response from the * ListLambdaFunctions service method, as returned by Amazon * Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListLambdaFunctionsResult listLambdaFunctions( ListLambdaFunctionsRequest listLambdaFunctionsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listLexBotsRequest * @return listLexBotsResult The response from the ListLexBots service * method, as returned by Amazon Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the phone numbers for the specified Amazon * Connect instance. *

*

* For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon * Connect Administrator Guide. *

* *

* The phone number Arn value that is returned from each of the * items in the PhoneNumberSummaryList cannot be used to tag phone number resources. * It will fail with a ResourceNotFoundException. Instead, use * the ListPhoneNumbersV2 API. It returns the new phone number ARN that can * be used to tag phone number resources. *

*
* * @param listPhoneNumbersRequest * @return listPhoneNumbersResult The response from the ListPhoneNumbers * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listPhoneNumbersV2Request * @return listPhoneNumbersV2Result The response from the ListPhoneNumbersV2 * service method, as returned by Amazon Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the prompts for the specified Amazon Connect * instance. *

* * @param listPromptsRequest * @return listPromptsResult The response from the ListPrompts service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Lists the quick connects associated with a queue. *

* * @param listQueueQuickConnectsRequest * @return listQueueQuickConnectsResult The response from the * ListQueueQuickConnects service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListQueueQuickConnectsResult listQueueQuickConnects( ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listQueuesRequest * @return listQueuesResult The response from the ListQueues service method, * as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the quick connects for the specified Amazon * Connect instance. *

* * @param listQuickConnectsRequest * @return listQuickConnectsResult The response from the ListQuickConnects * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists the queues associated with a routing profile. *

* * @param listRoutingProfileQueuesRequest * @return listRoutingProfileQueuesResult The response from the * ListRoutingProfileQueues service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListRoutingProfileQueuesResult listRoutingProfileQueues( ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listRoutingProfilesRequest * @return listRoutingProfilesResult The response from the * ListRoutingProfiles service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListRoutingProfilesResult listRoutingProfiles( ListRoutingProfilesRequest listRoutingProfilesRequest) throws AmazonClientException, AmazonServiceException; /** *

* List all rules for the specified Amazon Connect instance. *

* * @param listRulesRequest * @return listRulesResult The response from the ListRules service method, * as returned by Amazon Connect. * @throws InvalidRequestException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListRulesResult listRules(ListRulesRequest listRulesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listSecurityKeysRequest * @return listSecurityKeysResult The response from the ListSecurityKeys * service method, as returned by Amazon Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Lists the permissions granted to a security profile. *

* * @param listSecurityProfilePermissionsRequest * @return listSecurityProfilePermissionsResult The response from the * ListSecurityProfilePermissions service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListSecurityProfilePermissionsResult listSecurityProfilePermissions( ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listSecurityProfilesRequest * @return listSecurityProfilesResult The response from the * ListSecurityProfiles service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListSecurityProfilesResult listSecurityProfiles( ListSecurityProfilesRequest listSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listTagsForResourceRequest * @return listTagsForResourceResult The response from the * ListTagsForResource service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListTagsForResourceResult listTagsForResource( ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists task templates for the specified Amazon Connect instance. *

* * @param listTaskTemplatesRequest * @return listTaskTemplatesResult The response from the ListTaskTemplates * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists traffic distribution groups. *

* * @param listTrafficDistributionGroupsRequest * @return listTrafficDistributionGroupsResult The response from the * ListTrafficDistributionGroups service method, as returned by * Amazon Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListTrafficDistributionGroupsResult listTrafficDistributionGroups( ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Lists the use cases for the integration association. *

* * @param listUseCasesRequest

* Provides summary information about the use cases for the * specified integration association. *

* @return listUseCasesResult The response from the ListUseCases service * method, as returned by Amazon Connect. * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param listUserHierarchyGroupsRequest * @return listUserHierarchyGroupsResult The response from the * ListUserHierarchyGroups service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListUserHierarchyGroupsResult listUserHierarchyGroups( ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides summary information about the users for the specified Amazon * Connect instance. *

* * @param listUsersRequest * @return listUsersResult The response from the ListUsers service method, * as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param monitorContactRequest * @return monitorContactResult The response from the MonitorContact service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws IdempotencyException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ MonitorContactResult monitorContact(MonitorContactRequest monitorContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param putUserStatusRequest * @return putUserStatusResult The response from the PutUserStatus service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AccessDeniedException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ PutUserStatusResult putUserStatus(PutUserStatusRequest putUserStatusRequest) throws AmazonClientException, AmazonServiceException; /** *

* Releases a phone number previously claimed to an Amazon Connect instance * or traffic distribution group. You can call this API only in the Amazon * Web Services Region where the number was claimed. *

* *

* To release phone numbers from a traffic distribution group, use the * ReleasePhoneNumber API, not the Amazon Connect console. *

*

* After releasing a phone number, the phone number enters into a cooldown * period of 30 days. It cannot be searched for or claimed again until the * period has ended. If you accidentally release a phone number, contact * Amazon Web Services Support. *

*
*

* If you plan to claim and release numbers frequently during a 30 day * period, contact us for a service quota exception. Otherwise, it is * possible you will be blocked from claiming and releasing any more numbers * until 30 days past the oldest number released has expired. *

*

* By default you can claim and release up to 200% of your maximum number of * active phone numbers during any 30 day period. If you claim and release * phone numbers using the UI or API during a rolling 30 day cycle that * exceeds 200% of your phone number service level quota, you will be * blocked from claiming any more numbers until 30 days past the oldest * number released has expired. *

*

* For example, if you already have 99 claimed numbers and a service level * quota of 99 phone numbers, and in any 30 day period you release 99, claim * 99, and then release 99, you will have exceeded the 200% limit. At that * point you are blocked from claiming any more numbers until you open an * Amazon Web Services support ticket. *

* * @param releasePhoneNumberRequest * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceInUseException * @throws IdempotencyException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest) throws AmazonClientException, AmazonServiceException; /** *

* Replicates an Amazon Connect instance in the specified Amazon Web * Services Region. *

*

* For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the * Amazon Connect Administrator Guide. *

* * @param replicateInstanceRequest * @return replicateInstanceResult The response from the ReplicateInstance * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ResourceNotReadyException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest replicateInstanceRequest) throws AmazonClientException, AmazonServiceException; /** *

* When a contact is being recorded, and the recording has been suspended * using SuspendContactRecording, this API resumes recording the call or * screen. *

*

* Voice and screen recordings are supported. *

* * @param resumeContactRecordingRequest * @return resumeContactRecordingResult The response from the * ResumeContactRecording service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ ResumeContactRecordingResult resumeContactRecording( ResumeContactRecordingRequest resumeContactRecordingRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param searchAvailablePhoneNumbersRequest * @return searchAvailablePhoneNumbersResult The response from the * SearchAvailablePhoneNumbers service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ThrottlingException * @throws InternalServiceException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers( SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches the hours of operation in an Amazon Connect instance, with * optional filtering. *

* * @param searchHoursOfOperationsRequest * @return searchHoursOfOperationsResult The response from the * SearchHoursOfOperations service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchHoursOfOperationsResult searchHoursOfOperations( SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches prompts in an Amazon Connect instance, with optional filtering. *

* * @param searchPromptsRequest * @return searchPromptsResult The response from the SearchPrompts service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchPromptsResult searchPrompts(SearchPromptsRequest searchPromptsRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Searches queues in an Amazon Connect instance, with optional filtering. *

* * @param searchQueuesRequest * @return searchQueuesResult The response from the SearchQueues service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchQueuesResult searchQueues(SearchQueuesRequest searchQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches quick connects in an Amazon Connect instance, with optional * filtering. *

* * @param searchQuickConnectsRequest * @return searchQuickConnectsResult The response from the * SearchQuickConnects service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchQuickConnectsResult searchQuickConnects( SearchQuickConnectsRequest searchQuickConnectsRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches tags used in an Amazon Connect instance using optional search * criteria. *

* * @param searchResourceTagsRequest * @return searchResourceTagsResult The response from the SearchResourceTags * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws MaximumResultReturnedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Searches routing profiles in an Amazon Connect instance, with optional * filtering. *

* * @param searchRoutingProfilesRequest * @return searchRoutingProfilesResult The response from the * SearchRoutingProfiles service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchRoutingProfilesResult searchRoutingProfiles( SearchRoutingProfilesRequest searchRoutingProfilesRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Searches security profiles in an Amazon Connect instance, with optional * filtering. *

* * @param searchSecurityProfilesRequest * @return searchSecurityProfilesResult The response from the * SearchSecurityProfiles service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchSecurityProfilesResult searchSecurityProfiles( SearchSecurityProfilesRequest searchSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches users in an Amazon Connect instance, with optional filtering. *

* *

* AfterContactWorkTimeLimit is returned in milliseconds. *

*
* * @param searchUsersRequest * @return searchUsersResult The response from the SearchUsers service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest) throws AmazonClientException, AmazonServiceException; /** *

* Searches for vocabularies within a specific Amazon Connect instance using * State, NameStartsWith, and * LanguageCode. *

* * @param searchVocabulariesRequest * @return searchVocabulariesResult The response from the SearchVocabularies * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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: *

* *

* If you use the ChatDurationInMinutes parameter and receive a * 400 error, your account may not support the ability to configure custom * chat durations. For more information, contact Amazon Web Services * Support. *

*

* For more information about chat, see Chat in the Amazon Connect Administrator Guide. *

* * @param startChatContactRequest * @return startChatContactResult The response from the StartChatContact * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param startContactEvaluationRequest * @return startContactEvaluationResult The response from the * StartContactEvaluation service method, as returned by Amazon * Connect. * @throws InternalServiceException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceQuotaExceededException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartContactEvaluationResult startContactEvaluation( StartContactEvaluationRequest startContactEvaluationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Starts recording the contact: *

* *

* 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. *

* * @param startContactRecordingRequest * @return startContactRecordingResult The response from the * StartContactRecording service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartContactRecordingResult startContactRecording( StartContactRecordingRequest startContactRecordingRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param startContactStreamingRequest * @return startContactStreamingResult The response from the * StartContactStreaming service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartContactStreamingResult startContactStreaming( StartContactStreamingRequest startContactStreamingRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param startOutboundVoiceContactRequest * @return startOutboundVoiceContactResult The response from the * StartOutboundVoiceContact service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws LimitExceededException * @throws DestinationNotAllowedException * @throws OutboundContactNotPermittedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartOutboundVoiceContactResult startOutboundVoiceContact( StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* Initiates a flow to start a new task. *

* * @param startTaskContactRequest * @return startTaskContactResult The response from the StartTaskContact * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceQuotaExceededException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* Ends the specified contact. This call does not work for the following * initiation methods: *

* * * @param stopContactRequest * @return stopContactResult The response from the StopContact service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws ContactNotFoundException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StopContactResult stopContact(StopContactRequest stopContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param stopContactRecordingRequest * @return stopContactRecordingResult The response from the * StopContactRecording service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StopContactRecordingResult stopContactRecording( StopContactRecordingRequest stopContactRecordingRequest) throws AmazonClientException, AmazonServiceException; /** *

* Ends message streaming on a specified contact. To restart message * streaming on that contact, call the StartContactStreaming API. *

* * @param stopContactStreamingRequest * @return stopContactStreamingResult The response from the * StopContactStreaming service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ StopContactStreamingResult stopContactStreaming( StopContactStreamingRequest stopContactStreamingRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param submitContactEvaluationRequest * @return submitContactEvaluationResult The response from the * SubmitContactEvaluation service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SubmitContactEvaluationResult submitContactEvaluation( SubmitContactEvaluationRequest submitContactEvaluationRequest) throws AmazonClientException, AmazonServiceException; /** *

* When a contact is being recorded, this API suspends recording the call or * screen. For example, you might suspend the call or screen recording while * collecting sensitive information, such as a credit card number. Then use * ResumeContactRecording to restart recording. *

*

* The period of time that the recording is suspended is filled with silence * in the final recording. *

*

* Voice and screen recordings are supported. *

* * @param suspendContactRecordingRequest * @return suspendContactRecordingResult The response from the * SuspendContactRecording service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ SuspendContactRecordingResult suspendContactRecording( SuspendContactRecordingRequest suspendContactRecordingRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param tagResourceRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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: *

* * * @param transferContactRequest * @return transferContactResult The response from the TransferContact * service method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws IdempotencyException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws ServiceQuotaExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ TransferContactResult transferContact(TransferContactRequest transferContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* Removes the specified tags from the specified resource. *

* * @param untagResourceRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws InternalServiceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates agent status. *

* * @param updateAgentStatusRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param updateContactRequest * @return updateContactResult The response from the UpdateContact service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactResult updateContact(UpdateContactRequest updateContactRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateContactAttributesRequest * @return updateContactAttributesResult The response from the * UpdateContactAttributes service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactAttributesResult updateContactAttributes( UpdateContactAttributesRequest updateContactAttributesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateContactEvaluationRequest * @return updateContactEvaluationResult The response from the * UpdateContactEvaluation service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactEvaluationResult updateContactEvaluation( UpdateContactEvaluationRequest updateContactEvaluationRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the specified flow. *

*

* You can also create and update flows using the Amazon Connect Flow language. *

* * @param updateContactFlowContentRequest * @return updateContactFlowContentResult The response from the * UpdateContactFlowContent service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidContactFlowException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactFlowContentResult updateContactFlowContent( UpdateContactFlowContentRequest updateContactFlowContentRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates metadata about specified flow. *

* * @param updateContactFlowMetadataRequest * @return updateContactFlowMetadataResult The response from the * UpdateContactFlowMetadata service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactFlowMetadataResult updateContactFlowMetadata( UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates specified flow module for the specified Amazon Connect instance. *

* * @param updateContactFlowModuleContentRequest * @return updateContactFlowModuleContentResult The response from the * UpdateContactFlowModuleContent service method, as returned by * Amazon Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidContactFlowModuleException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactFlowModuleContentResult updateContactFlowModuleContent( UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates metadata about specified flow module. *

* * @param updateContactFlowModuleMetadataRequest * @return updateContactFlowModuleMetadataResult The response from the * UpdateContactFlowModuleMetadata service method, as returned by * Amazon Connect. * @throws AccessDeniedException * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata( UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest) throws AmazonClientException, AmazonServiceException; /** *

* The name of the flow. *

*

* You can also create and update flows using the Amazon Connect Flow language. *

* * @param updateContactFlowNameRequest * @return updateContactFlowNameResult The response from the * UpdateContactFlowName service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactFlowNameResult updateContactFlowName( UpdateContactFlowNameRequest updateContactFlowNameRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the scheduled time of a task contact that is already scheduled. *

* * @param updateContactScheduleRequest * @return updateContactScheduleResult The response from the * UpdateContactSchedule service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws LimitExceededException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateContactScheduleResult updateContactSchedule( UpdateContactScheduleRequest updateContactScheduleRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateEvaluationFormRequest * @return updateEvaluationFormResult The response from the * UpdateEvaluationForm service method, as returned by Amazon * Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ServiceQuotaExceededException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateEvaluationFormResult updateEvaluationForm( UpdateEvaluationFormRequest updateEvaluationFormRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates the hours of operation. *

* * @param updateHoursOfOperationRequest * @throws DuplicateResourceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates the value for the specified attribute type. *

* * @param updateInstanceAttributeRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateInstanceStorageConfigRequest * @throws ResourceNotFoundException * @throws InternalServiceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateInstanceStorageConfig( UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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: *

* *

* For more information about how chat timeouts work, see Set up chat timeouts for human participants. *

* * @param updateParticipantRoleConfigRequest * @return updateParticipantRoleConfigResult The response from the * UpdateParticipantRoleConfig service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws AccessDeniedException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateParticipantRoleConfigResult updateParticipantRoleConfig( UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param updatePhoneNumberRequest * @return updatePhoneNumberResult The response from the UpdatePhoneNumber * service method, as returned by Amazon Connect. * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws ResourceInUseException * @throws IdempotencyException * @throws AccessDeniedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates a prompt. *

* * @param updatePromptRequest * @return updatePromptResult The response from the UpdatePrompt service * method, as returned by Amazon Connect. * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdatePromptResult updatePrompt(UpdatePromptRequest updatePromptRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates the hours of operation for the specified queue. *

* * @param updateQueueHoursOfOperationRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQueueHoursOfOperation( UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateQueueMaxContactsRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateQueueNameRequest * @throws DuplicateResourceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQueueName(UpdateQueueNameRequest updateQueueNameRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates the outbound caller ID name, number, and outbound whisper flow * for a specified queue. *

* *

* If the number being used in the input is claimed to a traffic * distribution group, and you are calling this API using an instance in the * Amazon Web Services Region where the traffic distribution group was * created, you can use either a full phone number ARN or UUID value for the * OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number * is claimed to a traffic distribution group and you are calling this API * using an instance in the alternate Amazon Web Services Region associated * with the traffic distribution group, you must provide a full phone number * ARN. If a UUID is provided in this scenario, you will receive a * ResourceNotFoundException. *

*
* * @param updateQueueOutboundCallerConfigRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQueueOutboundCallerConfig( UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates the status of the queue. *

* * @param updateQueueStatusRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the configuration settings for the specified quick connect. *

* * @param updateQuickConnectConfigRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateQuickConnectNameRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the channels that agents can handle in the Contact Control Panel * (CCP) for a routing profile. *

* * @param updateRoutingProfileConcurrencyRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateRoutingProfileConcurrency( UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the default outbound queue of a routing profile. *

* * @param updateRoutingProfileDefaultOutboundQueueRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateRoutingProfileDefaultOutboundQueue( UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateRoutingProfileNameRequest * @throws DuplicateResourceException * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the properties associated with a set of queues for a routing * profile. *

* * @param updateRoutingProfileQueuesRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateRoutingProfileQueues( UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates a rule for the specified Amazon Connect instance. *

*

* Use the Rules Function language to code conditions for the rule. *

* * @param updateRuleRequest * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServiceException * @throws ThrottlingException * @throws AccessDeniedException * @throws ResourceConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateRule(UpdateRuleRequest updateRuleRequest) throws AmazonClientException, AmazonServiceException; /** *

* This API is in preview release for Amazon Connect and is subject to * change. *

*

* Updates a security profile. *

* * @param updateSecurityProfileRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

* * @param updateTaskTemplateRequest * @return updateTaskTemplateResult The response from the UpdateTaskTemplate * service method, as returned by Amazon Connect. * @throws PropertyValidationException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceQuotaExceededException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the traffic distribution for a given traffic distribution group. *

*

* 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. *

* * @param updateTrafficDistributionRequest * @return updateTrafficDistributionResult The response from the * UpdateTrafficDistribution service method, as returned by Amazon * Connect. * @throws InvalidRequestException * @throws AccessDeniedException * @throws ResourceNotFoundException * @throws ResourceConflictException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ UpdateTrafficDistributionResult updateTrafficDistribution( UpdateTrafficDistributionRequest updateTrafficDistributionRequest) throws AmazonClientException, AmazonServiceException; /** *

* Assigns the specified hierarchy group to the specified user. *

* * @param updateUserHierarchyRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the name of the user hierarchy group. *

* * @param updateUserHierarchyGroupNameRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws DuplicateResourceException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserHierarchyGroupName( UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the user hierarchy structure: add, remove, and rename user * hierarchy levels. *

* * @param updateUserHierarchyStructureRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ResourceInUseException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserHierarchyStructure( UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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. *

*
* * @param updateUserIdentityInfoRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) throws AmazonClientException, AmazonServiceException; /** *

* Updates the phone configuration settings for the specified user. *

* * @param updateUserPhoneConfigRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) throws AmazonClientException, AmazonServiceException; /** *

* Assigns the specified routing profile to the specified user. *

* * @param updateUserRoutingProfileRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) throws AmazonClientException, AmazonServiceException; /** *

* Assigns the specified security profiles to the specified user. *

* * @param updateUserSecurityProfilesRequest * @throws InvalidRequestException * @throws InvalidParameterException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServiceException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect indicating either a problem with the data in the * request, or a server side issue. */ void updateUserSecurityProfiles( UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException; /** * Shuts down this client object, releasing any resources that might be held * open. This is an optional method, and callers are not expected to call * it, but can if they want to explicitly release any open resources. Once a * client has been shutdown, it should not be used to make any more * requests. */ public void shutdown(); /** * Returns additional metadata for a previously executed successful request, * typically used for debugging issues where a service isn't acting as * expected. This data isn't considered part of the result data returned by * an operation, so it's available through this separate, diagnostic * interface. *

* Response metadata is only cached for a limited period of time, so if you * need to access this extra diagnostic information for an executed request, * you should use this method to retrieve it as soon as possible after * executing a request. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }