/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.connect.model.*; /** * Interface for accessing Amazon Connect. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.connect.AbstractAmazonConnect} instead. *
**
* Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center * and provide reliable customer engagement at any scale. *
** Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also * resolve customer issues more efficiently by getting customers in touch with the appropriate agents. *
** There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number * of requests that you can make per second. For more information, see Amazon Connect * Service Quotas in the Amazon Connect Administrator Guide. *
** You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect * endpoints, see Amazon Connect * Endpoints. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnect { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "connect"; /** ** 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 Result of the ActivateEvaluationForm operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.ActivateEvaluationForm * @see AWS * API Documentation */ ActivateEvaluationFormResult activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest); /** ** 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 * @return Result of the AssociateApprovedOrigin operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateApprovedOrigin * @see AWS API Documentation */ AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest); /** ** 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 * @return Result of the AssociateBot operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateBot * @see AWS API * Documentation */ AssociateBotResult associateBot(AssociateBotRequest associateBotRequest); /** ** 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 Result of the AssociateDefaultVocabulary operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.AssociateDefaultVocabulary * @see AWS API Documentation */ AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest); /** ** 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 Result of the AssociateInstanceStorageConfig operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateInstanceStorageConfig * @see AWS API Documentation */ AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest); /** ** 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 * @return Result of the AssociateLambdaFunction operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateLambdaFunction * @see AWS API Documentation */ AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports * the association of Amazon Lex V1 bots. *
* * @param associateLexBotRequest * @return Result of the AssociateLexBot operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateLexBot * @see AWS API * Documentation */ AssociateLexBotResult associateLexBot(AssociateLexBotRequest associateLexBotRequest); /** ** 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
.
*
* 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 * @return Result of the AssociateQueueQuickConnects operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.AssociateQueueQuickConnects * @see AWS API Documentation */ AssociateQueueQuickConnectsResult associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest); /** ** Associates a set of queues with a routing profile. *
* * @param associateRoutingProfileQueuesRequest * @return Result of the AssociateRoutingProfileQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.AssociateRoutingProfileQueues * @see AWS API Documentation */ AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Associates a security key to the instance. *
* * @param associateSecurityKeyRequest * @return Result of the AssociateSecurityKey operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.AssociateSecurityKey * @see AWS * API Documentation */ AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest); /** ** 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 Result of the ClaimPhoneNumber operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws IdempotencyException * An entity with the same name already exists. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.ClaimPhoneNumber * @see AWS API * Documentation */ ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest); /** ** 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 Result of the CreateAgentStatus operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateAgentStatus * @see AWS API * Documentation */ CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest); /** ** 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 Result of the CreateContactFlow operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidContactFlowException * The flow is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateContactFlow * @see AWS API * Documentation */ CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest); /** ** Creates a flow module for the specified Amazon Connect instance. *
* * @param createContactFlowModuleRequest * @return Result of the CreateContactFlowModule operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidContactFlowModuleException * The problems with the module. Please fix before trying again. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws IdempotencyException * An entity with the same name already exists. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateContactFlowModule * @see AWS API Documentation */ CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest); /** ** 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 Result of the CreateEvaluationForm operation returned by the service. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.CreateEvaluationForm * @see AWS * API Documentation */ CreateEvaluationFormResult createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Creates hours of operation. *
* * @param createHoursOfOperationRequest * @return Result of the CreateHoursOfOperation operation returned by the service. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateHoursOfOperation * @see AWS * API Documentation */ CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest); /** ** 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 Result of the CreateInstance operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateInstance * @see AWS API * Documentation */ CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest); /** ** Creates an Amazon Web Services resource association with an Amazon Connect instance. *
* * @param createIntegrationAssociationRequest * @return Result of the CreateIntegrationAssociation operation returned by the service. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.CreateIntegrationAssociation * @see AWS API Documentation */ CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest); /** ** 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 Result of the CreateParticipant operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.CreateParticipant * @see AWS API * Documentation */ CreateParticipantResult createParticipant(CreateParticipantRequest createParticipantRequest); /** ** 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 Result of the CreatePrompt operation returned by the service. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreatePrompt * @see AWS API * Documentation */ CreatePromptResult createPrompt(CreatePromptRequest createPromptRequest); /** ** 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
.
*
* Only use the phone number ARN format that doesn't contain instance
in the path, for example,
* arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned
* when you call the ListPhoneNumbersV2
* API.
*
* Creates a quick connect for the specified Amazon Connect instance. *
* * @param createQuickConnectRequest * @return Result of the CreateQuickConnect operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateQuickConnect * @see AWS API * Documentation */ CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest); /** ** Creates a new routing profile. *
* * @param createRoutingProfileRequest * @return Result of the CreateRoutingProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateRoutingProfile * @see AWS * API Documentation */ CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest); /** ** Creates a rule for the specified Amazon Connect instance. *
** Use the Rules * Function language to code conditions for the rule. *
* * @param createRuleRequest * @return Result of the CreateRule operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceConflictException * A resource already has that name. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @sample AmazonConnect.CreateRule * @see AWS API * Documentation */ CreateRuleResult createRule(CreateRuleRequest createRuleRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Creates a security profile. *
* * @param createSecurityProfileRequest * @return Result of the CreateSecurityProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateSecurityProfile * @see AWS * API Documentation */ CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest); /** ** Creates a new task template in the specified Amazon Connect instance. *
* * @param createTaskTemplateRequest * @return Result of the CreateTaskTemplate operation returned by the service. * @throws PropertyValidationException * The property is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateTaskTemplate * @see AWS API * Documentation */ CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest); /** ** 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 Result of the CreateTrafficDistributionGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceConflictException * A resource already has that name. * @throws ResourceNotReadyException * The resource is not ready. * @sample AmazonConnect.CreateTrafficDistributionGroup * @see AWS API Documentation */ CreateTrafficDistributionGroupResult createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest); /** ** Creates a use case for an integration association. *
* * @param createUseCaseRequest * @return Result of the CreateUseCase operation returned by the service. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.CreateUseCase * @see AWS API * Documentation */ CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest); /** ** 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 Result of the CreateUser operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateUser * @see AWS API * Documentation */ CreateUserResult createUser(CreateUserRequest createUserRequest); /** ** Creates a new user hierarchy group. *
* * @param createUserHierarchyGroupRequest * @return Result of the CreateUserHierarchyGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.CreateUserHierarchyGroup * @see AWS API Documentation */ CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest); /** ** 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 Result of the CreateVocabulary operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceConflictException * A resource already has that name. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @sample AmazonConnect.CreateVocabulary * @see AWS API * Documentation */ CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest); /** ** 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 Result of the DeactivateEvaluationForm operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.DeactivateEvaluationForm * @see AWS API Documentation */ DeactivateEvaluationFormResult deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest); /** ** Deletes a contact evaluation in the specified Amazon Connect instance. *
* * @param deleteContactEvaluationRequest * @return Result of the DeleteContactEvaluation operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.DeleteContactEvaluation * @see AWS API Documentation */ DeleteContactEvaluationResult deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest); /** ** Deletes a flow for the specified Amazon Connect instance. *
* * @param deleteContactFlowRequest * @return Result of the DeleteContactFlow operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DeleteContactFlow * @see AWS API * Documentation */ DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest); /** ** Deletes the specified flow module. *
* * @param deleteContactFlowModuleRequest * @return Result of the DeleteContactFlowModule operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteContactFlowModule * @see AWS API Documentation */ DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest); /** ** Deletes an evaluation form in the specified Amazon Connect instance. *
** If the version property is provided, only the specified version of the evaluation form is deleted. *
** If no version is provided, then the full form (all versions) is deleted. *
** This API is in preview release for Amazon Connect and is subject to change. *
** Deletes an hours of operation. *
* * @param deleteHoursOfOperationRequest * @return Result of the DeleteHoursOfOperation operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteHoursOfOperation * @see AWS * API Documentation */ DeleteHoursOfOperationResult deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest); /** ** 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 * @return Result of the DeleteInstance operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @sample AmazonConnect.DeleteInstance * @see AWS API * Documentation */ DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest); /** ** 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 * @return Result of the DeleteIntegrationAssociation operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DeleteIntegrationAssociation * @see AWS API Documentation */ DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest); /** ** Deletes a prompt. *
* * @param deletePromptRequest * @return Result of the DeletePrompt operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeletePrompt * @see AWS API * Documentation */ DeletePromptResult deletePrompt(DeletePromptRequest deletePromptRequest); /** ** Deletes a queue. *
* * @param deleteQueueRequest * @return Result of the DeleteQueue operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteQueue * @see AWS API * Documentation */ DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest); /** ** Deletes a quick connect. *
* * @param deleteQuickConnectRequest * @return Result of the DeleteQuickConnect operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteQuickConnect * @see AWS API * Documentation */ DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest); /** ** Deletes a routing profile. *
* * @param deleteRoutingProfileRequest * @return Result of the DeleteRoutingProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteRoutingProfile * @see AWS * API Documentation */ DeleteRoutingProfileResult deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest); /** ** Deletes a rule for the specified Amazon Connect instance. *
* * @param deleteRuleRequest * @return Result of the DeleteRule operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.DeleteRule * @see AWS API * Documentation */ DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Deletes a security profile. *
* * @param deleteSecurityProfileRequest * @return Result of the DeleteSecurityProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceInUseException * That resource is already in use. Please try another. * @sample AmazonConnect.DeleteSecurityProfile * @see AWS * API Documentation */ DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest); /** ** Deletes the task template. *
* * @param deleteTaskTemplateRequest * @return Result of the DeleteTaskTemplate operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteTaskTemplate * @see AWS API * Documentation */ DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest); /** ** 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 Result of the DeleteTrafficDistributionGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteTrafficDistributionGroup * @see AWS API Documentation */ DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest); /** ** Deletes a use case from an integration association. *
* * @param deleteUseCaseRequest * @return Result of the DeleteUseCase operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DeleteUseCase * @see AWS API * Documentation */ DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest); /** ** 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 * @return Result of the DeleteUser operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteUser * @see AWS API * Documentation */ DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest); /** ** Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child * groups. *
* * @param deleteUserHierarchyGroupRequest * @return Result of the DeleteUserHierarchyGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DeleteUserHierarchyGroup * @see AWS API Documentation */ DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest); /** ** Deletes the vocabulary that has the given identifier. *
* * @param deleteVocabularyRequest * @return Result of the DeleteVocabulary operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceInUseException * That resource is already in use. Please try another. * @sample AmazonConnect.DeleteVocabulary * @see AWS API * Documentation */ DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Describes an agent status. *
* * @param describeAgentStatusRequest * @return Result of the DescribeAgentStatus operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeAgentStatus * @see AWS * API Documentation */ DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest); /** ** 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. *
** Describes a contact evaluation in the specified Amazon Connect instance. *
* * @param describeContactEvaluationRequest * @return Result of the DescribeContactEvaluation operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeContactEvaluation * @see AWS API Documentation */ DescribeContactEvaluationResult describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest); /** ** Describes the specified flow. *
** You can also create and update flows using the Amazon Connect Flow * language. *
* * @param describeContactFlowRequest * @return Result of the DescribeContactFlow operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ContactFlowNotPublishedException * The flow has not been published. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeContactFlow * @see AWS * API Documentation */ DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest); /** ** Describes the specified flow module. *
* * @param describeContactFlowModuleRequest * @return Result of the DescribeContactFlowModule operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeContactFlowModule * @see AWS API Documentation */ DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest); /** ** 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 Result of the DescribeEvaluationForm operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeEvaluationForm * @see AWS * API Documentation */ DescribeEvaluationFormResult describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Describes the hours of operation. *
* * @param describeHoursOfOperationRequest * @return Result of the DescribeHoursOfOperation operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeHoursOfOperation * @see AWS API Documentation */ DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest); /** ** 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 Result of the DescribeInstance operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeInstance * @see AWS API * Documentation */ DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Describes the specified instance attribute. *
* * @param describeInstanceAttributeRequest * @return Result of the DescribeInstanceAttribute operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DescribeInstanceAttribute * @see AWS API Documentation */ DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest); /** ** 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 Result of the DescribeInstanceStorageConfig operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DescribeInstanceStorageConfig * @see AWS API Documentation */ DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest); /** ** 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
.
*
* Describes the prompt. *
* * @param describePromptRequest * @return Result of the DescribePrompt operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribePrompt * @see AWS API * Documentation */ DescribePromptResult describePrompt(DescribePromptRequest describePromptRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Describes the specified queue. *
* * @param describeQueueRequest * @return Result of the DescribeQueue operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeQueue * @see AWS API * Documentation */ DescribeQueueResult describeQueue(DescribeQueueRequest describeQueueRequest); /** ** Describes the quick connect. *
* * @param describeQuickConnectRequest * @return Result of the DescribeQuickConnect operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeQuickConnect * @see AWS * API Documentation */ DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest); /** ** Describes the specified routing profile. *
* * @param describeRoutingProfileRequest * @return Result of the DescribeRoutingProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeRoutingProfile * @see AWS * API Documentation */ DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest); /** ** Describes a rule for the specified Amazon Connect instance. *
* * @param describeRuleRequest * @return Result of the DescribeRule operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.DescribeRule * @see AWS API * Documentation */ DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Gets basic information about the security profle. *
* * @param describeSecurityProfileRequest * @return Result of the DescribeSecurityProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeSecurityProfile * @see AWS API Documentation */ DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest); /** ** Gets details and status of a traffic distribution group. *
* * @param describeTrafficDistributionGroupRequest * @return Result of the DescribeTrafficDistributionGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DescribeTrafficDistributionGroup * @see AWS API Documentation */ DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest); /** ** 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 Result of the DescribeUser operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeUser * @see AWS API * Documentation */ DescribeUserResult describeUser(DescribeUserRequest describeUserRequest); /** ** Describes the specified hierarchy group. *
* * @param describeUserHierarchyGroupRequest * @return Result of the DescribeUserHierarchyGroup operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeUserHierarchyGroup * @see AWS API Documentation */ DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest); /** ** Describes the hierarchy structure of the specified Amazon Connect instance. *
* * @param describeUserHierarchyStructureRequest * @return Result of the DescribeUserHierarchyStructure operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DescribeUserHierarchyStructure * @see AWS API Documentation */ DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest); /** ** Describes the specified vocabulary. *
* * @param describeVocabularyRequest * @return Result of the DescribeVocabulary operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.DescribeVocabulary * @see AWS API * Documentation */ DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Revokes access to integrated applications from Amazon Connect. *
* * @param disassociateApprovedOriginRequest * @return Result of the DisassociateApprovedOrigin operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateApprovedOrigin * @see AWS API Documentation */ DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest); /** ** 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 * @return Result of the DisassociateBot operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateBot * @see AWS API * Documentation */ DisassociateBotResult disassociateBot(DisassociateBotRequest disassociateBotRequest); /** ** 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 * @return Result of the DisassociateInstanceStorageConfig operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateInstanceStorageConfig * @see AWS API Documentation */ DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest); /** ** 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 * @return Result of the DisassociateLambdaFunction operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateLambdaFunction * @see AWS API Documentation */ DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest); /** ** 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 * @return Result of the DisassociateLexBot operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateLexBot * @see AWS API * Documentation */ DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest); /** ** 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
.
*
* 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 * @return Result of the DisassociateQueueQuickConnects operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DisassociateQueueQuickConnects * @see AWS API Documentation */ DisassociateQueueQuickConnectsResult disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest); /** ** Disassociates a set of queues from a routing profile. *
* * @param disassociateRoutingProfileQueuesRequest * @return Result of the DisassociateRoutingProfileQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.DisassociateRoutingProfileQueues * @see AWS API Documentation */ DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Deletes the specified security key. *
* * @param disassociateSecurityKeyRequest * @return Result of the DisassociateSecurityKey operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.DisassociateSecurityKey * @see AWS API Documentation */ DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest); /** *
* 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.
*
* Retrieves the contact attributes for the specified contact. *
* * @param getContactAttributesRequest * @return Result of the GetContactAttributes operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.GetContactAttributes * @see AWS * API Documentation */ GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest); /** ** 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 Result of the GetCurrentMetricData operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonConnect.GetCurrentMetricData * @see AWS * API Documentation */ GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest); /** ** Gets the real-time active user data from the specified Amazon Connect instance. *
* * @param getCurrentUserDataRequest * @return Result of the GetCurrentUserData operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonConnect.GetCurrentUserData * @see AWS API * Documentation */ GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest); /** ** 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
*
* 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 Result of the GetMetricData operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonConnect.GetMetricData * @see AWS API * Documentation */ GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest); /** ** 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.
*
* Gets the prompt file. *
* * @param getPromptFileRequest * @return Result of the GetPromptFile operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.GetPromptFile * @see AWS API * Documentation */ GetPromptFileResult getPromptFile(GetPromptFileRequest getPromptFileRequest); /** ** Gets details about a specific task template in the specified Amazon Connect instance. *
* * @param getTaskTemplateRequest * @return Result of the GetTaskTemplate operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.GetTaskTemplate * @see AWS API * Documentation */ GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest); /** ** Retrieves the current traffic distribution for a given traffic distribution group. *
* * @param getTrafficDistributionRequest * @return Result of the GetTrafficDistribution operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.GetTrafficDistribution * @see AWS * API Documentation */ GetTrafficDistributionResult getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Lists agent statuses. *
* * @param listAgentStatusesRequest * @return Result of the ListAgentStatuses operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListAgentStatuses * @see AWS API * Documentation */ ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest); /** ** 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 Result of the ListApprovedOrigins operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListApprovedOrigins * @see AWS * API Documentation */ ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest); /** ** 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 Result of the ListBots operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListBots * @see AWS API * Documentation */ ListBotsResult listBots(ListBotsRequest listBotsRequest); /** ** Lists contact evaluations in the specified Amazon Connect instance. *
* * @param listContactEvaluationsRequest * @return Result of the ListContactEvaluations operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListContactEvaluations * @see AWS * API Documentation */ ListContactEvaluationsResult listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest); /** ** Provides information about the flow modules for the specified Amazon Connect instance. *
* * @param listContactFlowModulesRequest * @return Result of the ListContactFlowModules operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListContactFlowModules * @see AWS * API Documentation */ ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest); /** ** 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 Result of the ListContactFlows operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListContactFlows * @see AWS API * Documentation */ ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest); /** ** 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.
*
* Lists the default vocabularies for the specified Amazon Connect instance. *
* * @param listDefaultVocabulariesRequest * @return Result of the ListDefaultVocabularies operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.ListDefaultVocabularies * @see AWS API Documentation */ ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest); /** ** Lists versions of an evaluation form in the specified Amazon Connect instance. *
* * @param listEvaluationFormVersionsRequest * @return Result of the ListEvaluationFormVersions operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListEvaluationFormVersions * @see AWS API Documentation */ ListEvaluationFormVersionsResult listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest); /** ** Lists evaluation forms in the specified Amazon Connect instance. *
* * @param listEvaluationFormsRequest * @return Result of the ListEvaluationForms operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListEvaluationForms * @see AWS * API Documentation */ ListEvaluationFormsResult listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest); /** ** 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 Result of the ListHoursOfOperations operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListHoursOfOperations * @see AWS * API Documentation */ ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest); /** ** 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 Result of the ListInstanceAttributes operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListInstanceAttributes * @see AWS * API Documentation */ ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest); /** ** 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 Result of the ListInstanceStorageConfigs operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListInstanceStorageConfigs * @see AWS API Documentation */ ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest); /** ** 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 Result of the ListInstances operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListInstances * @see AWS API * Documentation */ ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest); /** ** Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect * instance. *
* * @param listIntegrationAssociationsRequest * @return Result of the ListIntegrationAssociations operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListIntegrationAssociations * @see AWS API Documentation */ ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest); /** ** 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 Result of the ListLambdaFunctions operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListLambdaFunctions * @see AWS * API Documentation */ ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest); /** ** 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 Result of the ListLexBots operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListLexBots * @see AWS API * Documentation */ ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest); /** ** 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.
*
* 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 Result of the ListPhoneNumbersV2 operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.ListPhoneNumbersV2 * @see AWS API * Documentation */ ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request); /** ** Provides information about the prompts for the specified Amazon Connect instance. *
* * @param listPromptsRequest * @return Result of the ListPrompts operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListPrompts * @see AWS API * Documentation */ ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest); /** ** 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 Result of the ListQueueQuickConnects operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListQueueQuickConnects * @see AWS * API Documentation */ ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest); /** ** 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 Result of the ListQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListQueues * @see AWS API * Documentation */ ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest); /** ** Provides information about the quick connects for the specified Amazon Connect instance. *
* * @param listQuickConnectsRequest * @return Result of the ListQuickConnects operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListQuickConnects * @see AWS API * Documentation */ ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest); /** ** Lists the queues associated with a routing profile. *
* * @param listRoutingProfileQueuesRequest * @return Result of the ListRoutingProfileQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListRoutingProfileQueues * @see AWS API Documentation */ ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest); /** ** 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 Result of the ListRoutingProfiles operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListRoutingProfiles * @see AWS * API Documentation */ ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest); /** ** List all rules for the specified Amazon Connect instance. *
* * @param listRulesRequest * @return Result of the ListRules operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonConnect.ListRules * @see AWS API * Documentation */ ListRulesResult listRules(ListRulesRequest listRulesRequest); /** ** 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 Result of the ListSecurityKeys operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListSecurityKeys * @see AWS API * Documentation */ ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest); /** ** 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 Result of the ListSecurityProfilePermissions operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListSecurityProfilePermissions * @see AWS API Documentation */ ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest); /** ** 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 Result of the ListSecurityProfiles operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListSecurityProfiles * @see AWS * API Documentation */ ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest); /** ** 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 Result of the ListTagsForResource operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** Lists task templates for the specified Amazon Connect instance. *
* * @param listTaskTemplatesRequest * @return Result of the ListTaskTemplates operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListTaskTemplates * @see AWS API * Documentation */ ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest); /** ** Lists traffic distribution groups. *
* * @param listTrafficDistributionGroupsRequest * @return Result of the ListTrafficDistributionGroups operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListTrafficDistributionGroups * @see AWS API Documentation */ ListTrafficDistributionGroupsResult listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest); /** ** Lists the use cases for the integration association. *
* * @param listUseCasesRequest * Provides summary information about the use cases for the specified integration association. * @return Result of the ListUseCases operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.ListUseCases * @see AWS API * Documentation */ ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest); /** ** 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 Result of the ListUserHierarchyGroups operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListUserHierarchyGroups * @see AWS API Documentation */ ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest); /** ** Provides summary information about the users for the specified Amazon Connect instance. *
* * @param listUsersRequest * @return Result of the ListUsers operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ListUsers * @see AWS API * Documentation */ ListUsersResult listUsers(ListUsersRequest listUsersRequest); /** ** 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 Result of the MonitorContact operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws IdempotencyException * An entity with the same name already exists. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.MonitorContact * @see AWS API * Documentation */ MonitorContactResult monitorContact(MonitorContactRequest monitorContactRequest); /** ** 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 Result of the PutUserStatus operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.PutUserStatus * @see AWS API * Documentation */ PutUserStatusResult putUserStatus(PutUserStatusRequest putUserStatusRequest); /** ** 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 * @return Result of the ReleasePhoneNumber operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws IdempotencyException * An entity with the same name already exists. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonConnect.ReleasePhoneNumber * @see AWS API * Documentation */ ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest); /** ** 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 Result of the ReplicateInstance operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceNotReadyException * The resource is not ready. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.ReplicateInstance * @see AWS API * Documentation */ ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest replicateInstanceRequest); /** ** 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 Result of the ResumeContactRecording operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.ResumeContactRecording * @see AWS * API Documentation */ ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest); /** *
* 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.
*
* Searches the hours of operation in an Amazon Connect instance, with optional filtering. *
* * @param searchHoursOfOperationsRequest * @return Result of the SearchHoursOfOperations operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchHoursOfOperations * @see AWS API Documentation */ SearchHoursOfOperationsResult searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest); /** ** Searches prompts in an Amazon Connect instance, with optional filtering. *
* * @param searchPromptsRequest * @return Result of the SearchPrompts operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchPrompts * @see AWS API * Documentation */ SearchPromptsResult searchPrompts(SearchPromptsRequest searchPromptsRequest); /** ** Searches queues in an Amazon Connect instance, with optional filtering. *
* * @param searchQueuesRequest * @return Result of the SearchQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchQueues * @see AWS API * Documentation */ SearchQueuesResult searchQueues(SearchQueuesRequest searchQueuesRequest); /** ** Searches quick connects in an Amazon Connect instance, with optional filtering. *
* * @param searchQuickConnectsRequest * @return Result of the SearchQuickConnects operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchQuickConnects * @see AWS * API Documentation */ SearchQuickConnectsResult searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest); /** ** Searches tags used in an Amazon Connect instance using optional search criteria. *
* * @param searchResourceTagsRequest * @return Result of the SearchResourceTags operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws MaximumResultReturnedException * Maximum number (1000) of tags have been returned with current request. Consider changing request * parameters to get more tags. * @sample AmazonConnect.SearchResourceTags * @see AWS API * Documentation */ SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest); /** ** Searches routing profiles in an Amazon Connect instance, with optional filtering. *
* * @param searchRoutingProfilesRequest * @return Result of the SearchRoutingProfiles operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchRoutingProfiles * @see AWS * API Documentation */ SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest); /** ** Searches security profiles in an Amazon Connect instance, with optional filtering. *
* * @param searchSecurityProfilesRequest * @return Result of the SearchSecurityProfiles operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SearchSecurityProfiles * @see AWS * API Documentation */ SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest); /** ** Searches users in an Amazon Connect instance, with optional filtering. *
*
* AfterContactWorkTimeLimit
is returned in milliseconds.
*
* Searches for vocabularies within a specific Amazon Connect instance using State
,
* NameStartsWith
, and LanguageCode
.
*
* Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain * credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. *
** When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the * created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. *
** A 429 error occurs in the following situations: *
*
* API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
*
* The quota for
* concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
*
* If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support
* the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
*
* For more information about chat, see Chat in the Amazon Connect * Administrator Guide. *
* * @param startChatContactRequest * @return Result of the StartChatContact operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @sample AmazonConnect.StartChatContact * @see AWS API * Documentation */ StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest); /** ** 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. *
** Starts recording the contact: *
** If the API is called before the agent joins the call, recording starts when the agent joins the call. *
** If the API is called after the agent joins the call, recording starts at the time of the API call. *
** StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an * ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started * and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card * number), use SuspendContactRecording and ResumeContactRecording. *
** You can use this API to override the recording behavior configured in the Set recording * behavior block. *
** Only voice recordings are supported at this time. *
* * @param startContactRecordingRequest * @return Result of the StartContactRecording operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.StartContactRecording * @see AWS * API Documentation */ StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest); /** ** 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 Result of the StartContactStreaming operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @sample AmazonConnect.StartContactStreaming * @see AWS * API Documentation */ StartContactStreamingResult startContactStreaming(StartContactStreamingRequest startContactStreamingRequest); /** *
* 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.
*
* Initiates a flow to start a new task. *
* * @param startTaskContactRequest * @return Result of the StartTaskContact operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.StartTaskContact * @see AWS API * Documentation */ StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest); /** ** Ends the specified contact. This call does not work for the following initiation methods: *
** DISCONNECT *
** TRANSFER *
** QUEUE_TRANSFER *
** 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 Result of the StopContactRecording operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.StopContactRecording * @see AWS * API Documentation */ StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest); /** ** Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API. *
* * @param stopContactStreamingRequest * @return Result of the StopContactStreaming operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.StopContactStreaming * @see AWS * API Documentation */ StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest); /** *
* 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 Result of the SubmitContactEvaluation operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.SubmitContactEvaluation * @see AWS API Documentation */ SubmitContactEvaluationResult submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest); /** ** 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 Result of the SuspendContactRecording operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.SuspendContactRecording * @see AWS API Documentation */ SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest); /** ** 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 * @return Result of the TagResource operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You * can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination * queue. This gives you more control over contact handling and helps you adhere to the service level agreement * (SLA) guaranteed to your customers. *
** Note the following requirements: *
*
* Transfer is supported for only TASK
contacts.
*
* Do not use both QueueId
and UserId
in the same call.
*
* The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. *
*
* The TransferContact
API can be called only on active contacts.
*
* A contact cannot be transferred more than 11 times. *
** Removes the specified tags from the specified resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Updates agent status. *
* * @param updateAgentStatusRequest * @return Result of the UpdateAgentStatus operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateAgentStatus * @see AWS API * Documentation */ UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest); /** ** 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. *
** 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 Result of the UpdateContactAttributes operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactAttributes * @see AWS API Documentation */ UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest); /** *
* 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.
*
* Updates the specified flow. *
** You can also create and update flows using the Amazon Connect Flow * language. *
* * @param updateContactFlowContentRequest * @return Result of the UpdateContactFlowContent operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidContactFlowException * The flow is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactFlowContent * @see AWS API Documentation */ UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest); /** ** Updates metadata about specified flow. *
* * @param updateContactFlowMetadataRequest * @return Result of the UpdateContactFlowMetadata operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactFlowMetadata * @see AWS API Documentation */ UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest); /** ** Updates specified flow module for the specified Amazon Connect instance. *
* * @param updateContactFlowModuleContentRequest * @return Result of the UpdateContactFlowModuleContent operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidContactFlowModuleException * The problems with the module. Please fix before trying again. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactFlowModuleContent * @see AWS API Documentation */ UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest); /** ** Updates metadata about specified flow module. *
* * @param updateContactFlowModuleMetadataRequest * @return Result of the UpdateContactFlowModuleMetadata operation returned by the service. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactFlowModuleMetadata * @see AWS API Documentation */ UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest); /** ** The name of the flow. *
** You can also create and update flows using the Amazon Connect Flow * language. *
* * @param updateContactFlowNameRequest * @return Result of the UpdateContactFlowName operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactFlowName * @see AWS * API Documentation */ UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest); /** ** Updates the scheduled time of a task contact that is already scheduled. *
* * @param updateContactScheduleRequest * @return Result of the UpdateContactSchedule operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws LimitExceededException * The allowed limit for the resource has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateContactSchedule * @see AWS * API Documentation */ UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest); /** ** 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 Result of the UpdateEvaluationForm operation returned by the service. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.UpdateEvaluationForm * @see AWS * API Documentation */ UpdateEvaluationFormResult updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Updates the hours of operation. *
* * @param updateHoursOfOperationRequest * @return Result of the UpdateHoursOfOperation operation returned by the service. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateHoursOfOperation * @see AWS * API Documentation */ UpdateHoursOfOperationResult updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Updates the value for the specified attribute type. *
* * @param updateInstanceAttributeRequest * @return Result of the UpdateInstanceAttribute operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.UpdateInstanceAttribute * @see AWS API Documentation */ UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest); /** ** 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 * @return Result of the UpdateInstanceStorageConfig operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ThrottlingException * The throttling limit has been exceeded. * @sample AmazonConnect.UpdateInstanceStorageConfig * @see AWS API Documentation */ UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest); /** ** Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically * disconnected from a chat due to idleness. You can set four timers: *
** Customer idle timeout *
** Customer auto-disconnect timeout *
** Agent idle timeout *
** Agent auto-disconnect timeout *
** For more information about how chat timeouts work, see Set up chat timeouts for * human participants. *
* * @param updateParticipantRoleConfigRequest * @return Result of the UpdateParticipantRoleConfig operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateParticipantRoleConfig * @see AWS API Documentation */ UpdateParticipantRoleConfigResult updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest); /** ** 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. *
** Updates a prompt. *
* * @param updatePromptRequest * @return Result of the UpdatePrompt operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdatePrompt * @see AWS API * Documentation */ UpdatePromptResult updatePrompt(UpdatePromptRequest updatePromptRequest); /** ** 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 * @return Result of the UpdateQueueHoursOfOperation operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateQueueHoursOfOperation * @see AWS API Documentation */ UpdateQueueHoursOfOperationResult updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest); /** ** 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 * @return Result of the UpdateQueueMaxContacts operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateQueueMaxContacts * @see AWS * API Documentation */ UpdateQueueMaxContactsResult updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest); /** ** 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.
*
* 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
.
*
* Only use the phone number ARN format that doesn't contain instance
in the path, for example,
* arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned
* when you call the ListPhoneNumbersV2
* API.
*
* This API is in preview release for Amazon Connect and is subject to change. *
** Updates the status of the queue. *
* * @param updateQueueStatusRequest * @return Result of the UpdateQueueStatus operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateQueueStatus * @see AWS API * Documentation */ UpdateQueueStatusResult updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest); /** ** Updates the configuration settings for the specified quick connect. *
* * @param updateQuickConnectConfigRequest * @return Result of the UpdateQuickConnectConfig operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateQuickConnectConfig * @see AWS API Documentation */ UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest); /** *
* 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.
*
* Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. *
* * @param updateRoutingProfileConcurrencyRequest * @return Result of the UpdateRoutingProfileConcurrency operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateRoutingProfileConcurrency * @see AWS API Documentation */ UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest); /** ** Updates the default outbound queue of a routing profile. *
* * @param updateRoutingProfileDefaultOutboundQueueRequest * @return Result of the UpdateRoutingProfileDefaultOutboundQueue operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateRoutingProfileDefaultOutboundQueue * @see AWS API Documentation */ UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue( UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest); /** *
* 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.
*
* Updates the properties associated with a set of queues for a routing profile. *
* * @param updateRoutingProfileQueuesRequest * @return Result of the UpdateRoutingProfileQueues operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateRoutingProfileQueues * @see AWS API Documentation */ UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest); /** ** Updates a rule for the specified Amazon Connect instance. *
** Use the Rules * Function language to code conditions for the rule. *
* * @param updateRuleRequest * @return Result of the UpdateRule operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceConflictException * A resource already has that name. * @sample AmazonConnect.UpdateRule * @see AWS API * Documentation */ UpdateRuleResult updateRule(UpdateRuleRequest updateRuleRequest); /** ** This API is in preview release for Amazon Connect and is subject to change. *
** Updates a security profile. *
* * @param updateSecurityProfileRequest * @return Result of the UpdateSecurityProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateSecurityProfile * @see AWS * API Documentation */ UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest); /** ** 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 Result of the UpdateTaskTemplate operation returned by the service. * @throws PropertyValidationException * The property is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws ServiceQuotaExceededException * The service quota has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateTaskTemplate * @see AWS API * Documentation */ UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest); /** ** 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 Result of the UpdateTrafficDistribution operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceConflictException * A resource already has that name. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateTrafficDistribution * @see AWS API Documentation */ UpdateTrafficDistributionResult updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest); /** ** Assigns the specified hierarchy group to the specified user. *
* * @param updateUserHierarchyRequest * @return Result of the UpdateUserHierarchy operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserHierarchy * @see AWS * API Documentation */ UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest); /** ** Updates the name of the user hierarchy group. *
* * @param updateUserHierarchyGroupNameRequest * @return Result of the UpdateUserHierarchyGroupName operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws DuplicateResourceException * A resource with the specified name already exists. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserHierarchyGroupName * @see AWS API Documentation */ UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest); /** ** Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. *
* * @param updateUserHierarchyStructureRequest * @return Result of the UpdateUserHierarchyStructure operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ResourceInUseException * That resource is already in use. Please try another. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserHierarchyStructure * @see AWS API Documentation */ UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest); /** ** 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.
*
* Updates the phone configuration settings for the specified user. *
* * @param updateUserPhoneConfigRequest * @return Result of the UpdateUserPhoneConfig operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserPhoneConfig * @see AWS * API Documentation */ UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest); /** ** Assigns the specified routing profile to the specified user. *
* * @param updateUserRoutingProfileRequest * @return Result of the UpdateUserRoutingProfile operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserRoutingProfile * @see AWS API Documentation */ UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest); /** ** Assigns the specified security profiles to the specified user. *
* * @param updateUserSecurityProfilesRequest * @return Result of the UpdateUserSecurityProfiles operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws InvalidParameterException * One or more of the specified parameters are not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ThrottlingException * The throttling limit has been exceeded. * @throws InternalServiceException * Request processing failed because of an error or failure with the service. * @sample AmazonConnect.UpdateUserSecurityProfiles * @see AWS API Documentation */ UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest); /** * 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. */ 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. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }