software.amazon.awssdk.services.connect

Interface ConnectClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface ConnectClient
extends AwsClient

Service client for accessing Amazon Connect. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
default ActivateEvaluationFormResponse	activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest) Activates an evaluation form in the specified Amazon Connect instance.
default ActivateEvaluationFormResponse	activateEvaluationForm(Consumer<ActivateEvaluationFormRequest.Builder> activateEvaluationFormRequest) Activates an evaluation form in the specified Amazon Connect instance.
default AssociateApprovedOriginResponse	associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateApprovedOriginResponse	associateApprovedOrigin(Consumer<AssociateApprovedOriginRequest.Builder> associateApprovedOriginRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateBotResponse	associateBot(AssociateBotRequest associateBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateBotResponse	associateBot(Consumer<AssociateBotRequest.Builder> associateBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateDefaultVocabularyResponse	associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest) Associates an existing vocabulary as the default.
default AssociateDefaultVocabularyResponse	associateDefaultVocabulary(Consumer<AssociateDefaultVocabularyRequest.Builder> associateDefaultVocabularyRequest) Associates an existing vocabulary as the default.
default AssociateInstanceStorageConfigResponse	associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateInstanceStorageConfigResponse	associateInstanceStorageConfig(Consumer<AssociateInstanceStorageConfigRequest.Builder> associateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateLambdaFunctionResponse	associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateLambdaFunctionResponse	associateLambdaFunction(Consumer<AssociateLambdaFunctionRequest.Builder> associateLambdaFunctionRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateLexBotResponse	associateLexBot(AssociateLexBotRequest associateLexBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateLexBotResponse	associateLexBot(Consumer<AssociateLexBotRequest.Builder> associateLexBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociatePhoneNumberContactFlowResponse	associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest) Associates a flow with a phone number claimed to your Amazon Connect instance.
default AssociatePhoneNumberContactFlowResponse	associatePhoneNumberContactFlow(Consumer<AssociatePhoneNumberContactFlowRequest.Builder> associatePhoneNumberContactFlowRequest) Associates a flow with a phone number claimed to your Amazon Connect instance.
default AssociateQueueQuickConnectsResponse	associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateQueueQuickConnectsResponse	associateQueueQuickConnects(Consumer<AssociateQueueQuickConnectsRequest.Builder> associateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateRoutingProfileQueuesResponse	associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) Associates a set of queues with a routing profile.
default AssociateRoutingProfileQueuesResponse	associateRoutingProfileQueues(Consumer<AssociateRoutingProfileQueuesRequest.Builder> associateRoutingProfileQueuesRequest) Associates a set of queues with a routing profile.
default AssociateSecurityKeyResponse	associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateSecurityKeyResponse	associateSecurityKey(Consumer<AssociateSecurityKeyRequest.Builder> associateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.
default AssociateTrafficDistributionGroupUserResponse	associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest) Associates an agent with a traffic distribution group.
default AssociateTrafficDistributionGroupUserResponse	associateTrafficDistributionGroupUser(Consumer<AssociateTrafficDistributionGroupUserRequest.Builder> associateTrafficDistributionGroupUserRequest) Associates an agent with a traffic distribution group.
static ConnectClientBuilder	builder() Create a builder that can be used to configure and create a ConnectClient.
default ClaimPhoneNumberResponse	claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest) Claims an available phone number to your Amazon Connect instance or traffic distribution group.
default ClaimPhoneNumberResponse	claimPhoneNumber(Consumer<ClaimPhoneNumberRequest.Builder> claimPhoneNumberRequest) Claims an available phone number to your Amazon Connect instance or traffic distribution group.
static ConnectClient	create() Create a ConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAgentStatusResponse	createAgentStatus(Consumer<CreateAgentStatusRequest.Builder> createAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateAgentStatusResponse	createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateContactFlowResponse	createContactFlow(Consumer<CreateContactFlowRequest.Builder> createContactFlowRequest) Creates a flow for the specified Amazon Connect instance.
default CreateContactFlowResponse	createContactFlow(CreateContactFlowRequest createContactFlowRequest) Creates a flow for the specified Amazon Connect instance.
default CreateContactFlowModuleResponse	createContactFlowModule(Consumer<CreateContactFlowModuleRequest.Builder> createContactFlowModuleRequest) Creates a flow module for the specified Amazon Connect instance.
default CreateContactFlowModuleResponse	createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest) Creates a flow module for the specified Amazon Connect instance.
default CreateEvaluationFormResponse	createEvaluationForm(Consumer<CreateEvaluationFormRequest.Builder> createEvaluationFormRequest) Creates an evaluation form in the specified Amazon Connect instance.
default CreateEvaluationFormResponse	createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest) Creates an evaluation form in the specified Amazon Connect instance.
default CreateHoursOfOperationResponse	createHoursOfOperation(Consumer<CreateHoursOfOperationRequest.Builder> createHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateHoursOfOperationResponse	createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateInstanceResponse	createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateInstanceResponse	createInstance(CreateInstanceRequest createInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateIntegrationAssociationResponse	createIntegrationAssociation(Consumer<CreateIntegrationAssociationRequest.Builder> createIntegrationAssociationRequest) Creates an Amazon Web Services resource association with an Amazon Connect instance.
default CreateIntegrationAssociationResponse	createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest) Creates an Amazon Web Services resource association with an Amazon Connect instance.
default CreateParticipantResponse	createParticipant(Consumer<CreateParticipantRequest.Builder> createParticipantRequest) Adds a new participant into an on-going chat contact.
default CreateParticipantResponse	createParticipant(CreateParticipantRequest createParticipantRequest) Adds a new participant into an on-going chat contact.
default CreatePromptResponse	createPrompt(Consumer<CreatePromptRequest.Builder> createPromptRequest) Creates a prompt.
default CreatePromptResponse	createPrompt(CreatePromptRequest createPromptRequest) Creates a prompt.
default CreateQueueResponse	createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateQueueResponse	createQueue(CreateQueueRequest createQueueRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateQuickConnectResponse	createQuickConnect(Consumer<CreateQuickConnectRequest.Builder> createQuickConnectRequest) Creates a quick connect for the specified Amazon Connect instance.
default CreateQuickConnectResponse	createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest) Creates a quick connect for the specified Amazon Connect instance.
default CreateRoutingProfileResponse	createRoutingProfile(Consumer<CreateRoutingProfileRequest.Builder> createRoutingProfileRequest) Creates a new routing profile.
default CreateRoutingProfileResponse	createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest) Creates a new routing profile.
default CreateRuleResponse	createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) Creates a rule for the specified Amazon Connect instance.
default CreateRuleResponse	createRule(CreateRuleRequest createRuleRequest) Creates a rule for the specified Amazon Connect instance.
default CreateSecurityProfileResponse	createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateSecurityProfileResponse	createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default CreateTaskTemplateResponse	createTaskTemplate(Consumer<CreateTaskTemplateRequest.Builder> createTaskTemplateRequest) Creates a new task template in the specified Amazon Connect instance.
default CreateTaskTemplateResponse	createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest) Creates a new task template in the specified Amazon Connect instance.
default CreateTrafficDistributionGroupResponse	createTrafficDistributionGroup(Consumer<CreateTrafficDistributionGroupRequest.Builder> createTrafficDistributionGroupRequest) Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
default CreateTrafficDistributionGroupResponse	createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest) Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
default CreateUseCaseResponse	createUseCase(Consumer<CreateUseCaseRequest.Builder> createUseCaseRequest) Creates a use case for an integration association.
default CreateUseCaseResponse	createUseCase(CreateUseCaseRequest createUseCaseRequest) Creates a use case for an integration association.
default CreateUserResponse	createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user account for the specified Amazon Connect instance.
default CreateUserResponse	createUser(CreateUserRequest createUserRequest) Creates a user account for the specified Amazon Connect instance.
default CreateUserHierarchyGroupResponse	createUserHierarchyGroup(Consumer<CreateUserHierarchyGroupRequest.Builder> createUserHierarchyGroupRequest) Creates a new user hierarchy group.
default CreateUserHierarchyGroupResponse	createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest) Creates a new user hierarchy group.
default CreateVocabularyResponse	createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest) Creates a custom vocabulary associated with your Amazon Connect instance.
default CreateVocabularyResponse	createVocabulary(CreateVocabularyRequest createVocabularyRequest) Creates a custom vocabulary associated with your Amazon Connect instance.
default DeactivateEvaluationFormResponse	deactivateEvaluationForm(Consumer<DeactivateEvaluationFormRequest.Builder> deactivateEvaluationFormRequest) Deactivates an evaluation form in the specified Amazon Connect instance.
default DeactivateEvaluationFormResponse	deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest) Deactivates an evaluation form in the specified Amazon Connect instance.
default DeleteContactEvaluationResponse	deleteContactEvaluation(Consumer<DeleteContactEvaluationRequest.Builder> deleteContactEvaluationRequest) Deletes a contact evaluation in the specified Amazon Connect instance.
default DeleteContactEvaluationResponse	deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest) Deletes a contact evaluation in the specified Amazon Connect instance.
default DeleteContactFlowResponse	deleteContactFlow(Consumer<DeleteContactFlowRequest.Builder> deleteContactFlowRequest) Deletes a flow for the specified Amazon Connect instance.
default DeleteContactFlowResponse	deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest) Deletes a flow for the specified Amazon Connect instance.
default DeleteContactFlowModuleResponse	deleteContactFlowModule(Consumer<DeleteContactFlowModuleRequest.Builder> deleteContactFlowModuleRequest) Deletes the specified flow module.
default DeleteContactFlowModuleResponse	deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest) Deletes the specified flow module.
default DeleteEvaluationFormResponse	deleteEvaluationForm(Consumer<DeleteEvaluationFormRequest.Builder> deleteEvaluationFormRequest) Deletes an evaluation form in the specified Amazon Connect instance.
default DeleteEvaluationFormResponse	deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest) Deletes an evaluation form in the specified Amazon Connect instance.
default DeleteHoursOfOperationResponse	deleteHoursOfOperation(Consumer<DeleteHoursOfOperationRequest.Builder> deleteHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteHoursOfOperationResponse	deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteInstanceResponse	deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteInstanceResponse	deleteInstance(DeleteInstanceRequest deleteInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteIntegrationAssociationResponse	deleteIntegrationAssociation(Consumer<DeleteIntegrationAssociationRequest.Builder> deleteIntegrationAssociationRequest) Deletes an Amazon Web Services resource association from an Amazon Connect instance.
default DeleteIntegrationAssociationResponse	deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) Deletes an Amazon Web Services resource association from an Amazon Connect instance.
default DeletePromptResponse	deletePrompt(Consumer<DeletePromptRequest.Builder> deletePromptRequest) Deletes a prompt.
default DeletePromptResponse	deletePrompt(DeletePromptRequest deletePromptRequest) Deletes a prompt.
default DeleteQueueResponse	deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest) Deletes a queue.
default DeleteQueueResponse	deleteQueue(DeleteQueueRequest deleteQueueRequest) Deletes a queue.
default DeleteQuickConnectResponse	deleteQuickConnect(Consumer<DeleteQuickConnectRequest.Builder> deleteQuickConnectRequest) Deletes a quick connect.
default DeleteQuickConnectResponse	deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) Deletes a quick connect.
default DeleteRoutingProfileResponse	deleteRoutingProfile(Consumer<DeleteRoutingProfileRequest.Builder> deleteRoutingProfileRequest) Deletes a routing profile.
default DeleteRoutingProfileResponse	deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest) Deletes a routing profile.
default DeleteRuleResponse	deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) Deletes a rule for the specified Amazon Connect instance.
default DeleteRuleResponse	deleteRule(DeleteRuleRequest deleteRuleRequest) Deletes a rule for the specified Amazon Connect instance.
default DeleteSecurityProfileResponse	deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteSecurityProfileResponse	deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default DeleteTaskTemplateResponse	deleteTaskTemplate(Consumer<DeleteTaskTemplateRequest.Builder> deleteTaskTemplateRequest) Deletes the task template.
default DeleteTaskTemplateResponse	deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest) Deletes the task template.
default DeleteTrafficDistributionGroupResponse	deleteTrafficDistributionGroup(Consumer<DeleteTrafficDistributionGroupRequest.Builder> deleteTrafficDistributionGroupRequest) Deletes a traffic distribution group.
default DeleteTrafficDistributionGroupResponse	deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest) Deletes a traffic distribution group.
default DeleteUseCaseResponse	deleteUseCase(Consumer<DeleteUseCaseRequest.Builder> deleteUseCaseRequest) Deletes a use case from an integration association.
default DeleteUseCaseResponse	deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest) Deletes a use case from an integration association.
default DeleteUserResponse	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user account from the specified Amazon Connect instance.
default DeleteUserResponse	deleteUser(DeleteUserRequest deleteUserRequest) Deletes a user account from the specified Amazon Connect instance.
default DeleteUserHierarchyGroupResponse	deleteUserHierarchyGroup(Consumer<DeleteUserHierarchyGroupRequest.Builder> deleteUserHierarchyGroupRequest) Deletes an existing user hierarchy group.
default DeleteUserHierarchyGroupResponse	deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest) Deletes an existing user hierarchy group.
default DeleteVocabularyResponse	deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest) Deletes the vocabulary that has the given identifier.
default DeleteVocabularyResponse	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) Deletes the vocabulary that has the given identifier.
default DescribeAgentStatusResponse	describeAgentStatus(Consumer<DescribeAgentStatusRequest.Builder> describeAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeAgentStatusResponse	describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeContactResponse	describeContact(Consumer<DescribeContactRequest.Builder> describeContactRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeContactResponse	describeContact(DescribeContactRequest describeContactRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeContactEvaluationResponse	describeContactEvaluation(Consumer<DescribeContactEvaluationRequest.Builder> describeContactEvaluationRequest) Describes a contact evaluation in the specified Amazon Connect instance.
default DescribeContactEvaluationResponse	describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest) Describes a contact evaluation in the specified Amazon Connect instance.
default DescribeContactFlowResponse	describeContactFlow(Consumer<DescribeContactFlowRequest.Builder> describeContactFlowRequest) Describes the specified flow.
default DescribeContactFlowResponse	describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest) Describes the specified flow.
default DescribeContactFlowModuleResponse	describeContactFlowModule(Consumer<DescribeContactFlowModuleRequest.Builder> describeContactFlowModuleRequest) Describes the specified flow module.
default DescribeContactFlowModuleResponse	describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest) Describes the specified flow module.
default DescribeEvaluationFormResponse	describeEvaluationForm(Consumer<DescribeEvaluationFormRequest.Builder> describeEvaluationFormRequest) Describes an evaluation form in the specified Amazon Connect instance.
default DescribeEvaluationFormResponse	describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest) Describes an evaluation form in the specified Amazon Connect instance.
default DescribeHoursOfOperationResponse	describeHoursOfOperation(Consumer<DescribeHoursOfOperationRequest.Builder> describeHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeHoursOfOperationResponse	describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceResponse	describeInstance(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceResponse	describeInstance(DescribeInstanceRequest describeInstanceRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceAttributeResponse	describeInstanceAttribute(Consumer<DescribeInstanceAttributeRequest.Builder> describeInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceAttributeResponse	describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceStorageConfigResponse	describeInstanceStorageConfig(Consumer<DescribeInstanceStorageConfigRequest.Builder> describeInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeInstanceStorageConfigResponse	describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribePhoneNumberResponse	describePhoneNumber(Consumer<DescribePhoneNumberRequest.Builder> describePhoneNumberRequest) Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
default DescribePhoneNumberResponse	describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest) Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
default DescribePromptResponse	describePrompt(Consumer<DescribePromptRequest.Builder> describePromptRequest) Describes the prompt.
default DescribePromptResponse	describePrompt(DescribePromptRequest describePromptRequest) Describes the prompt.
default DescribeQueueResponse	describeQueue(Consumer<DescribeQueueRequest.Builder> describeQueueRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeQueueResponse	describeQueue(DescribeQueueRequest describeQueueRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeQuickConnectResponse	describeQuickConnect(Consumer<DescribeQuickConnectRequest.Builder> describeQuickConnectRequest) Describes the quick connect.
default DescribeQuickConnectResponse	describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest) Describes the quick connect.
default DescribeRoutingProfileResponse	describeRoutingProfile(Consumer<DescribeRoutingProfileRequest.Builder> describeRoutingProfileRequest) Describes the specified routing profile.
default DescribeRoutingProfileResponse	describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest) Describes the specified routing profile.
default DescribeRuleResponse	describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest) Describes a rule for the specified Amazon Connect instance.
default DescribeRuleResponse	describeRule(DescribeRuleRequest describeRuleRequest) Describes a rule for the specified Amazon Connect instance.
default DescribeSecurityProfileResponse	describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeSecurityProfileResponse	describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default DescribeTrafficDistributionGroupResponse	describeTrafficDistributionGroup(Consumer<DescribeTrafficDistributionGroupRequest.Builder> describeTrafficDistributionGroupRequest) Gets details and status of a traffic distribution group.
default DescribeTrafficDistributionGroupResponse	describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest) Gets details and status of a traffic distribution group.
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Describes the specified user account.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest) Describes the specified user account.
default DescribeUserHierarchyGroupResponse	describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest) Describes the specified hierarchy group.
default DescribeUserHierarchyGroupResponse	describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) Describes the specified hierarchy group.
default DescribeUserHierarchyStructureResponse	describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest) Describes the hierarchy structure of the specified Amazon Connect instance.
default DescribeUserHierarchyStructureResponse	describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) Describes the hierarchy structure of the specified Amazon Connect instance.
default DescribeVocabularyResponse	describeVocabulary(Consumer<DescribeVocabularyRequest.Builder> describeVocabularyRequest) Describes the specified vocabulary.
default DescribeVocabularyResponse	describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest) Describes the specified vocabulary.
default DisassociateApprovedOriginResponse	disassociateApprovedOrigin(Consumer<DisassociateApprovedOriginRequest.Builder> disassociateApprovedOriginRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateApprovedOriginResponse	disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateBotResponse	disassociateBot(Consumer<DisassociateBotRequest.Builder> disassociateBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateBotResponse	disassociateBot(DisassociateBotRequest disassociateBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateInstanceStorageConfigResponse	disassociateInstanceStorageConfig(Consumer<DisassociateInstanceStorageConfigRequest.Builder> disassociateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateInstanceStorageConfigResponse	disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateLambdaFunctionResponse	disassociateLambdaFunction(Consumer<DisassociateLambdaFunctionRequest.Builder> disassociateLambdaFunctionRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateLambdaFunctionResponse	disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateLexBotResponse	disassociateLexBot(Consumer<DisassociateLexBotRequest.Builder> disassociateLexBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateLexBotResponse	disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociatePhoneNumberContactFlowResponse	disassociatePhoneNumberContactFlow(Consumer<DisassociatePhoneNumberContactFlowRequest.Builder> disassociatePhoneNumberContactFlowRequest) Removes the flow association from a phone number claimed to your Amazon Connect instance.
default DisassociatePhoneNumberContactFlowResponse	disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest) Removes the flow association from a phone number claimed to your Amazon Connect instance.
default DisassociateQueueQuickConnectsResponse	disassociateQueueQuickConnects(Consumer<DisassociateQueueQuickConnectsRequest.Builder> disassociateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateQueueQuickConnectsResponse	disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateRoutingProfileQueuesResponse	disassociateRoutingProfileQueues(Consumer<DisassociateRoutingProfileQueuesRequest.Builder> disassociateRoutingProfileQueuesRequest) Disassociates a set of queues from a routing profile.
default DisassociateRoutingProfileQueuesResponse	disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) Disassociates a set of queues from a routing profile.
default DisassociateSecurityKeyResponse	disassociateSecurityKey(Consumer<DisassociateSecurityKeyRequest.Builder> disassociateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateSecurityKeyResponse	disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.
default DisassociateTrafficDistributionGroupUserResponse	disassociateTrafficDistributionGroupUser(Consumer<DisassociateTrafficDistributionGroupUserRequest.Builder> disassociateTrafficDistributionGroupUserRequest) Disassociates an agent from a traffic distribution group.
default DisassociateTrafficDistributionGroupUserResponse	disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest) Disassociates an agent from a traffic distribution group.
default DismissUserContactResponse	dismissUserContact(Consumer<DismissUserContactRequest.Builder> dismissUserContactRequest) Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact.
default DismissUserContactResponse	dismissUserContact(DismissUserContactRequest dismissUserContactRequest) Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact.
default GetContactAttributesResponse	getContactAttributes(Consumer<GetContactAttributesRequest.Builder> getContactAttributesRequest) Retrieves the contact attributes for the specified contact.
default GetContactAttributesResponse	getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) Retrieves the contact attributes for the specified contact.
default GetCurrentMetricDataResponse	getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest) Gets the real-time metric data from the specified Amazon Connect instance.
default GetCurrentMetricDataResponse	getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) Gets the real-time metric data from the specified Amazon Connect instance.
default GetCurrentMetricDataIterable	getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest) Gets the real-time metric data from the specified Amazon Connect instance.
default GetCurrentMetricDataIterable	getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest) Gets the real-time metric data from the specified Amazon Connect instance.
default GetCurrentUserDataResponse	getCurrentUserData(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest) Gets the real-time active user data from the specified Amazon Connect instance.
default GetCurrentUserDataResponse	getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest) Gets the real-time active user data from the specified Amazon Connect instance.
default GetCurrentUserDataIterable	getCurrentUserDataPaginator(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest) Gets the real-time active user data from the specified Amazon Connect instance.
default GetCurrentUserDataIterable	getCurrentUserDataPaginator(GetCurrentUserDataRequest getCurrentUserDataRequest) Gets the real-time active user data from the specified Amazon Connect instance.
default GetFederationTokenResponse	getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest) Retrieves a token for federation.
default GetFederationTokenResponse	getFederationToken(GetFederationTokenRequest getFederationTokenRequest) Retrieves a token for federation.
default GetMetricDataResponse	getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) Gets historical metric data from the specified Amazon Connect instance.
default GetMetricDataResponse	getMetricData(GetMetricDataRequest getMetricDataRequest) Gets historical metric data from the specified Amazon Connect instance.
default GetMetricDataIterable	getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) Gets historical metric data from the specified Amazon Connect instance.
default GetMetricDataIterable	getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest) Gets historical metric data from the specified Amazon Connect instance.
default GetMetricDataV2Response	getMetricDataV2(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request) Gets metric data from the specified Amazon Connect instance.
default GetMetricDataV2Response	getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request) Gets metric data from the specified Amazon Connect instance.
default GetMetricDataV2Iterable	getMetricDataV2Paginator(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request) Gets metric data from the specified Amazon Connect instance.
default GetMetricDataV2Iterable	getMetricDataV2Paginator(GetMetricDataV2Request getMetricDataV2Request) Gets metric data from the specified Amazon Connect instance.
default GetPromptFileResponse	getPromptFile(Consumer<GetPromptFileRequest.Builder> getPromptFileRequest) Gets the prompt file.
default GetPromptFileResponse	getPromptFile(GetPromptFileRequest getPromptFileRequest) Gets the prompt file.
default GetTaskTemplateResponse	getTaskTemplate(Consumer<GetTaskTemplateRequest.Builder> getTaskTemplateRequest) Gets details about a specific task template in the specified Amazon Connect instance.
default GetTaskTemplateResponse	getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest) Gets details about a specific task template in the specified Amazon Connect instance.
default GetTrafficDistributionResponse	getTrafficDistribution(Consumer<GetTrafficDistributionRequest.Builder> getTrafficDistributionRequest) Retrieves the current traffic distribution for a given traffic distribution group.
default GetTrafficDistributionResponse	getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest) Retrieves the current traffic distribution for a given traffic distribution group.
default ListAgentStatusesResponse	listAgentStatuses(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListAgentStatusesResponse	listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListAgentStatusesIterable	listAgentStatusesPaginator(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListAgentStatusesIterable	listAgentStatusesPaginator(ListAgentStatusesRequest listAgentStatusesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListApprovedOriginsResponse	listApprovedOrigins(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListApprovedOriginsResponse	listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListApprovedOriginsIterable	listApprovedOriginsPaginator(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListApprovedOriginsIterable	listApprovedOriginsPaginator(ListApprovedOriginsRequest listApprovedOriginsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListBotsResponse	listBots(Consumer<ListBotsRequest.Builder> listBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListBotsResponse	listBots(ListBotsRequest listBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListBotsIterable	listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListBotsIterable	listBotsPaginator(ListBotsRequest listBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListContactEvaluationsResponse	listContactEvaluations(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest) Lists contact evaluations in the specified Amazon Connect instance.
default ListContactEvaluationsResponse	listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest) Lists contact evaluations in the specified Amazon Connect instance.
default ListContactEvaluationsIterable	listContactEvaluationsPaginator(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest) Lists contact evaluations in the specified Amazon Connect instance.
default ListContactEvaluationsIterable	listContactEvaluationsPaginator(ListContactEvaluationsRequest listContactEvaluationsRequest) Lists contact evaluations in the specified Amazon Connect instance.
default ListContactFlowModulesResponse	listContactFlowModules(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest) Provides information about the flow modules for the specified Amazon Connect instance.
default ListContactFlowModulesResponse	listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest) Provides information about the flow modules for the specified Amazon Connect instance.
default ListContactFlowModulesIterable	listContactFlowModulesPaginator(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest) Provides information about the flow modules for the specified Amazon Connect instance.
default ListContactFlowModulesIterable	listContactFlowModulesPaginator(ListContactFlowModulesRequest listContactFlowModulesRequest) Provides information about the flow modules for the specified Amazon Connect instance.
default ListContactFlowsResponse	listContactFlows(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest) Provides information about the flows for the specified Amazon Connect instance.
default ListContactFlowsResponse	listContactFlows(ListContactFlowsRequest listContactFlowsRequest) Provides information about the flows for the specified Amazon Connect instance.
default ListContactFlowsIterable	listContactFlowsPaginator(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest) Provides information about the flows for the specified Amazon Connect instance.
default ListContactFlowsIterable	listContactFlowsPaginator(ListContactFlowsRequest listContactFlowsRequest) Provides information about the flows for the specified Amazon Connect instance.
default ListContactReferencesResponse	listContactReferences(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListContactReferencesResponse	listContactReferences(ListContactReferencesRequest listContactReferencesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListContactReferencesIterable	listContactReferencesPaginator(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListContactReferencesIterable	listContactReferencesPaginator(ListContactReferencesRequest listContactReferencesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListDefaultVocabulariesResponse	listDefaultVocabularies(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest) Lists the default vocabularies for the specified Amazon Connect instance.
default ListDefaultVocabulariesResponse	listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) Lists the default vocabularies for the specified Amazon Connect instance.
default ListDefaultVocabulariesIterable	listDefaultVocabulariesPaginator(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest) Lists the default vocabularies for the specified Amazon Connect instance.
default ListDefaultVocabulariesIterable	listDefaultVocabulariesPaginator(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) Lists the default vocabularies for the specified Amazon Connect instance.
default ListEvaluationFormsResponse	listEvaluationForms(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest) Lists evaluation forms in the specified Amazon Connect instance.
default ListEvaluationFormsResponse	listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest) Lists evaluation forms in the specified Amazon Connect instance.
default ListEvaluationFormsIterable	listEvaluationFormsPaginator(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest) Lists evaluation forms in the specified Amazon Connect instance.
default ListEvaluationFormsIterable	listEvaluationFormsPaginator(ListEvaluationFormsRequest listEvaluationFormsRequest) Lists evaluation forms in the specified Amazon Connect instance.
default ListEvaluationFormVersionsResponse	listEvaluationFormVersions(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.
default ListEvaluationFormVersionsResponse	listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.
default ListEvaluationFormVersionsIterable	listEvaluationFormVersionsPaginator(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.
default ListEvaluationFormVersionsIterable	listEvaluationFormVersionsPaginator(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.
default ListHoursOfOperationsResponse	listHoursOfOperations(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest) Provides information about the hours of operation for the specified Amazon Connect instance.
default ListHoursOfOperationsResponse	listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest) Provides information about the hours of operation for the specified Amazon Connect instance.
default ListHoursOfOperationsIterable	listHoursOfOperationsPaginator(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest) Provides information about the hours of operation for the specified Amazon Connect instance.
default ListHoursOfOperationsIterable	listHoursOfOperationsPaginator(ListHoursOfOperationsRequest listHoursOfOperationsRequest) Provides information about the hours of operation for the specified Amazon Connect instance.
default ListInstanceAttributesResponse	listInstanceAttributes(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceAttributesResponse	listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceAttributesIterable	listInstanceAttributesPaginator(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceAttributesIterable	listInstanceAttributesPaginator(ListInstanceAttributesRequest listInstanceAttributesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstancesResponse	listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstancesResponse	listInstances(ListInstancesRequest listInstancesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstancesIterable	listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstancesIterable	listInstancesPaginator(ListInstancesRequest listInstancesRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceStorageConfigsResponse	listInstanceStorageConfigs(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceStorageConfigsResponse	listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceStorageConfigsIterable	listInstanceStorageConfigsPaginator(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListInstanceStorageConfigsIterable	listInstanceStorageConfigsPaginator(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListIntegrationAssociationsResponse	listIntegrationAssociations(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
default ListIntegrationAssociationsResponse	listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
default ListIntegrationAssociationsIterable	listIntegrationAssociationsPaginator(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
default ListIntegrationAssociationsIterable	listIntegrationAssociationsPaginator(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
default ListLambdaFunctionsResponse	listLambdaFunctions(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLambdaFunctionsResponse	listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLambdaFunctionsIterable	listLambdaFunctionsPaginator(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLambdaFunctionsIterable	listLambdaFunctionsPaginator(ListLambdaFunctionsRequest listLambdaFunctionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLexBotsResponse	listLexBots(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLexBotsResponse	listLexBots(ListLexBotsRequest listLexBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLexBotsIterable	listLexBotsPaginator(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListLexBotsIterable	listLexBotsPaginator(ListLexBotsRequest listLexBotsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListPhoneNumbersResponse	listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) Provides information about the phone numbers for the specified Amazon Connect instance.
default ListPhoneNumbersResponse	listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) Provides information about the phone numbers for the specified Amazon Connect instance.
default ListPhoneNumbersIterable	listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) Provides information about the phone numbers for the specified Amazon Connect instance.
default ListPhoneNumbersIterable	listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) Provides information about the phone numbers for the specified Amazon Connect instance.
default ListPhoneNumbersV2Response	listPhoneNumbersV2(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request) Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
default ListPhoneNumbersV2Response	listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request) Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
default ListPhoneNumbersV2Iterable	listPhoneNumbersV2Paginator(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request) Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
default ListPhoneNumbersV2Iterable	listPhoneNumbersV2Paginator(ListPhoneNumbersV2Request listPhoneNumbersV2Request) Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
default ListPromptsResponse	listPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest) Provides information about the prompts for the specified Amazon Connect instance.
default ListPromptsResponse	listPrompts(ListPromptsRequest listPromptsRequest) Provides information about the prompts for the specified Amazon Connect instance.
default ListPromptsIterable	listPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest) Provides information about the prompts for the specified Amazon Connect instance.
default ListPromptsIterable	listPromptsPaginator(ListPromptsRequest listPromptsRequest) Provides information about the prompts for the specified Amazon Connect instance.
default ListQueueQuickConnectsResponse	listQueueQuickConnects(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListQueueQuickConnectsResponse	listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListQueueQuickConnectsIterable	listQueueQuickConnectsPaginator(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListQueueQuickConnectsIterable	listQueueQuickConnectsPaginator(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListQueuesResponse	listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest) Provides information about the queues for the specified Amazon Connect instance.
default ListQueuesResponse	listQueues(ListQueuesRequest listQueuesRequest) Provides information about the queues for the specified Amazon Connect instance.
default ListQueuesIterable	listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest) Provides information about the queues for the specified Amazon Connect instance.
default ListQueuesIterable	listQueuesPaginator(ListQueuesRequest listQueuesRequest) Provides information about the queues for the specified Amazon Connect instance.
default ListQuickConnectsResponse	listQuickConnects(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest) Provides information about the quick connects for the specified Amazon Connect instance.
default ListQuickConnectsResponse	listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest) Provides information about the quick connects for the specified Amazon Connect instance.
default ListQuickConnectsIterable	listQuickConnectsPaginator(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest) Provides information about the quick connects for the specified Amazon Connect instance.
default ListQuickConnectsIterable	listQuickConnectsPaginator(ListQuickConnectsRequest listQuickConnectsRequest) Provides information about the quick connects for the specified Amazon Connect instance.
default ListRoutingProfileQueuesResponse	listRoutingProfileQueues(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest) Lists the queues associated with a routing profile.
default ListRoutingProfileQueuesResponse	listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) Lists the queues associated with a routing profile.
default ListRoutingProfileQueuesIterable	listRoutingProfileQueuesPaginator(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest) Lists the queues associated with a routing profile.
default ListRoutingProfileQueuesIterable	listRoutingProfileQueuesPaginator(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) Lists the queues associated with a routing profile.
default ListRoutingProfilesResponse	listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest) Provides summary information about the routing profiles for the specified Amazon Connect instance.
default ListRoutingProfilesResponse	listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) Provides summary information about the routing profiles for the specified Amazon Connect instance.
default ListRoutingProfilesIterable	listRoutingProfilesPaginator(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest) Provides summary information about the routing profiles for the specified Amazon Connect instance.
default ListRoutingProfilesIterable	listRoutingProfilesPaginator(ListRoutingProfilesRequest listRoutingProfilesRequest) Provides summary information about the routing profiles for the specified Amazon Connect instance.
default ListRulesResponse	listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) List all rules for the specified Amazon Connect instance.
default ListRulesResponse	listRules(ListRulesRequest listRulesRequest) List all rules for the specified Amazon Connect instance.
default ListRulesIterable	listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest) List all rules for the specified Amazon Connect instance.
default ListRulesIterable	listRulesPaginator(ListRulesRequest listRulesRequest) List all rules for the specified Amazon Connect instance.
default ListSecurityKeysResponse	listSecurityKeys(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityKeysResponse	listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityKeysIterable	listSecurityKeysPaginator(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityKeysIterable	listSecurityKeysPaginator(ListSecurityKeysRequest listSecurityKeysRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityProfilePermissionsResponse	listSecurityProfilePermissions(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityProfilePermissionsResponse	listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityProfilePermissionsIterable	listSecurityProfilePermissionsPaginator(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityProfilePermissionsIterable	listSecurityProfilePermissionsPaginator(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) This API is in preview release for Amazon Connect and is subject to change.
default ListSecurityProfilesResponse	listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) Provides summary information about the security profiles for the specified Amazon Connect instance.
default ListSecurityProfilesResponse	listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) Provides summary information about the security profiles for the specified Amazon Connect instance.
default ListSecurityProfilesIterable	listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) Provides summary information about the security profiles for the specified Amazon Connect instance.
default ListSecurityProfilesIterable	listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest) Provides summary information about the security profiles for the specified Amazon Connect instance.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
default ListTaskTemplatesResponse	listTaskTemplates(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest) Lists task templates for the specified Amazon Connect instance.
default ListTaskTemplatesResponse	listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest) Lists task templates for the specified Amazon Connect instance.
default ListTaskTemplatesIterable	listTaskTemplatesPaginator(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest) Lists task templates for the specified Amazon Connect instance.
default ListTaskTemplatesIterable	listTaskTemplatesPaginator(ListTaskTemplatesRequest listTaskTemplatesRequest) Lists task templates for the specified Amazon Connect instance.
default ListTrafficDistributionGroupsResponse	listTrafficDistributionGroups(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest) Lists traffic distribution groups.
default ListTrafficDistributionGroupsResponse	listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) Lists traffic distribution groups.
default ListTrafficDistributionGroupsIterable	listTrafficDistributionGroupsPaginator(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest) Lists traffic distribution groups.
default ListTrafficDistributionGroupsIterable	listTrafficDistributionGroupsPaginator(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) Lists traffic distribution groups.
default ListTrafficDistributionGroupUsersResponse	listTrafficDistributionGroupUsers(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.
default ListTrafficDistributionGroupUsersResponse	listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.
default ListTrafficDistributionGroupUsersIterable	listTrafficDistributionGroupUsersPaginator(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.
default ListTrafficDistributionGroupUsersIterable	listTrafficDistributionGroupUsersPaginator(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.
default ListUseCasesResponse	listUseCases(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest) Lists the use cases for the integration association.
default ListUseCasesResponse	listUseCases(ListUseCasesRequest listUseCasesRequest) Lists the use cases for the integration association.
default ListUseCasesIterable	listUseCasesPaginator(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest) Lists the use cases for the integration association.
default ListUseCasesIterable	listUseCasesPaginator(ListUseCasesRequest listUseCasesRequest) Lists the use cases for the integration association.
default ListUserHierarchyGroupsResponse	listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest) Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
default ListUserHierarchyGroupsResponse	listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
default ListUserHierarchyGroupsIterable	listUserHierarchyGroupsPaginator(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest) Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
default ListUserHierarchyGroupsIterable	listUserHierarchyGroupsPaginator(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Provides summary information about the users for the specified Amazon Connect instance.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest) Provides summary information about the users for the specified Amazon Connect instance.
default ListUsersIterable	listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) Provides summary information about the users for the specified Amazon Connect instance.
default ListUsersIterable	listUsersPaginator(ListUsersRequest listUsersRequest) Provides summary information about the users for the specified Amazon Connect instance.
default MonitorContactResponse	monitorContact(Consumer<MonitorContactRequest.Builder> monitorContactRequest) Initiates silent monitoring of a contact.
default MonitorContactResponse	monitorContact(MonitorContactRequest monitorContactRequest) Initiates silent monitoring of a contact.
default PutUserStatusResponse	putUserStatus(Consumer<PutUserStatusRequest.Builder> putUserStatusRequest) Changes the current status of a user or agent in Amazon Connect.
default PutUserStatusResponse	putUserStatus(PutUserStatusRequest putUserStatusRequest) Changes the current status of a user or agent in Amazon Connect.
default ReleasePhoneNumberResponse	releasePhoneNumber(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest) Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
default ReleasePhoneNumberResponse	releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest) Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
default ReplicateInstanceResponse	replicateInstance(Consumer<ReplicateInstanceRequest.Builder> replicateInstanceRequest) Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
default ReplicateInstanceResponse	replicateInstance(ReplicateInstanceRequest replicateInstanceRequest) Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
default ResumeContactRecordingResponse	resumeContactRecording(Consumer<ResumeContactRecordingRequest.Builder> resumeContactRecordingRequest) When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call or screen.
default ResumeContactRecordingResponse	resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest) When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call or screen.
default SearchAvailablePhoneNumbersResponse	searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
default SearchAvailablePhoneNumbersResponse	searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
default SearchAvailablePhoneNumbersIterable	searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
default SearchAvailablePhoneNumbersIterable	searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
default SearchHoursOfOperationsResponse	searchHoursOfOperations(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest) Searches the hours of operation in an Amazon Connect instance, with optional filtering.
default SearchHoursOfOperationsResponse	searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) Searches the hours of operation in an Amazon Connect instance, with optional filtering.
default SearchHoursOfOperationsIterable	searchHoursOfOperationsPaginator(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest) Searches the hours of operation in an Amazon Connect instance, with optional filtering.
default SearchHoursOfOperationsIterable	searchHoursOfOperationsPaginator(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) Searches the hours of operation in an Amazon Connect instance, with optional filtering.
default SearchPromptsResponse	searchPrompts(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest) Searches prompts in an Amazon Connect instance, with optional filtering.
default SearchPromptsResponse	searchPrompts(SearchPromptsRequest searchPromptsRequest) Searches prompts in an Amazon Connect instance, with optional filtering.
default SearchPromptsIterable	searchPromptsPaginator(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest) Searches prompts in an Amazon Connect instance, with optional filtering.
default SearchPromptsIterable	searchPromptsPaginator(SearchPromptsRequest searchPromptsRequest) Searches prompts in an Amazon Connect instance, with optional filtering.
default SearchQueuesResponse	searchQueues(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest) Searches queues in an Amazon Connect instance, with optional filtering.
default SearchQueuesResponse	searchQueues(SearchQueuesRequest searchQueuesRequest) Searches queues in an Amazon Connect instance, with optional filtering.
default SearchQueuesIterable	searchQueuesPaginator(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest) Searches queues in an Amazon Connect instance, with optional filtering.
default SearchQueuesIterable	searchQueuesPaginator(SearchQueuesRequest searchQueuesRequest) Searches queues in an Amazon Connect instance, with optional filtering.
default SearchQuickConnectsResponse	searchQuickConnects(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest) Searches quick connects in an Amazon Connect instance, with optional filtering.
default SearchQuickConnectsResponse	searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest) Searches quick connects in an Amazon Connect instance, with optional filtering.
default SearchQuickConnectsIterable	searchQuickConnectsPaginator(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest) Searches quick connects in an Amazon Connect instance, with optional filtering.
default SearchQuickConnectsIterable	searchQuickConnectsPaginator(SearchQuickConnectsRequest searchQuickConnectsRequest) Searches quick connects in an Amazon Connect instance, with optional filtering.
default SearchResourceTagsResponse	searchResourceTags(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest) Searches tags used in an Amazon Connect instance using optional search criteria.
default SearchResourceTagsResponse	searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest) Searches tags used in an Amazon Connect instance using optional search criteria.
default SearchResourceTagsIterable	searchResourceTagsPaginator(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest) Searches tags used in an Amazon Connect instance using optional search criteria.
default SearchResourceTagsIterable	searchResourceTagsPaginator(SearchResourceTagsRequest searchResourceTagsRequest) Searches tags used in an Amazon Connect instance using optional search criteria.
default SearchRoutingProfilesResponse	searchRoutingProfiles(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest) Searches routing profiles in an Amazon Connect instance, with optional filtering.
default SearchRoutingProfilesResponse	searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest) Searches routing profiles in an Amazon Connect instance, with optional filtering.
default SearchRoutingProfilesIterable	searchRoutingProfilesPaginator(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest) Searches routing profiles in an Amazon Connect instance, with optional filtering.
default SearchRoutingProfilesIterable	searchRoutingProfilesPaginator(SearchRoutingProfilesRequest searchRoutingProfilesRequest) Searches routing profiles in an Amazon Connect instance, with optional filtering.
default SearchSecurityProfilesResponse	searchSecurityProfiles(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest) Searches security profiles in an Amazon Connect instance, with optional filtering.
default SearchSecurityProfilesResponse	searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest) Searches security profiles in an Amazon Connect instance, with optional filtering.
default SearchSecurityProfilesIterable	searchSecurityProfilesPaginator(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest) Searches security profiles in an Amazon Connect instance, with optional filtering.
default SearchSecurityProfilesIterable	searchSecurityProfilesPaginator(SearchSecurityProfilesRequest searchSecurityProfilesRequest) Searches security profiles in an Amazon Connect instance, with optional filtering.
default SearchUsersResponse	searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest) Searches users in an Amazon Connect instance, with optional filtering.
default SearchUsersResponse	searchUsers(SearchUsersRequest searchUsersRequest) Searches users in an Amazon Connect instance, with optional filtering.
default SearchUsersIterable	searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest) Searches users in an Amazon Connect instance, with optional filtering.
default SearchUsersIterable	searchUsersPaginator(SearchUsersRequest searchUsersRequest) Searches users in an Amazon Connect instance, with optional filtering.
default SearchVocabulariesResponse	searchVocabularies(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
default SearchVocabulariesResponse	searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
default SearchVocabulariesIterable	searchVocabulariesPaginator(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
default SearchVocabulariesIterable	searchVocabulariesPaginator(SearchVocabulariesRequest searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
default ConnectServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartChatContactResponse	startChatContact(Consumer<StartChatContactRequest.Builder> startChatContactRequest) Initiates a flow to start a new chat for the customer.
default StartChatContactResponse	startChatContact(StartChatContactRequest startChatContactRequest) Initiates a flow to start a new chat for the customer.
default StartContactEvaluationResponse	startContactEvaluation(Consumer<StartContactEvaluationRequest.Builder> startContactEvaluationRequest) Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
default StartContactEvaluationResponse	startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest) Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
default StartContactRecordingResponse	startContactRecording(Consumer<StartContactRecordingRequest.Builder> startContactRecordingRequest) Starts recording the contact:
default StartContactRecordingResponse	startContactRecording(StartContactRecordingRequest startContactRecordingRequest) Starts recording the contact:
default StartContactStreamingResponse	startContactStreaming(Consumer<StartContactStreamingRequest.Builder> startContactStreamingRequest) Initiates real-time message streaming for a new chat contact.
default StartContactStreamingResponse	startContactStreaming(StartContactStreamingRequest startContactStreamingRequest) Initiates real-time message streaming for a new chat contact.
default StartOutboundVoiceContactResponse	startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest) Places an outbound call to a contact, and then initiates the flow.
default StartOutboundVoiceContactResponse	startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) Places an outbound call to a contact, and then initiates the flow.
default StartTaskContactResponse	startTaskContact(Consumer<StartTaskContactRequest.Builder> startTaskContactRequest) Initiates a flow to start a new task.
default StartTaskContactResponse	startTaskContact(StartTaskContactRequest startTaskContactRequest) Initiates a flow to start a new task.
default StopContactResponse	stopContact(Consumer<StopContactRequest.Builder> stopContactRequest) Ends the specified contact.
default StopContactResponse	stopContact(StopContactRequest stopContactRequest) Ends the specified contact.
default StopContactRecordingResponse	stopContactRecording(Consumer<StopContactRecordingRequest.Builder> stopContactRecordingRequest) Stops recording a call when a contact is being recorded.
default StopContactRecordingResponse	stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest) Stops recording a call when a contact is being recorded.
default StopContactStreamingResponse	stopContactStreaming(Consumer<StopContactStreamingRequest.Builder> stopContactStreamingRequest) Ends message streaming on a specified contact.
default StopContactStreamingResponse	stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest) Ends message streaming on a specified contact.
default SubmitContactEvaluationResponse	submitContactEvaluation(Consumer<SubmitContactEvaluationRequest.Builder> submitContactEvaluationRequest) Submits a contact evaluation in the specified Amazon Connect instance.
default SubmitContactEvaluationResponse	submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest) Submits a contact evaluation in the specified Amazon Connect instance.
default SuspendContactRecordingResponse	suspendContactRecording(Consumer<SuspendContactRecordingRequest.Builder> suspendContactRecordingRequest) When a contact is being recorded, this API suspends recording the call or screen.
default SuspendContactRecordingResponse	suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) When a contact is being recorded, this API suspends recording the call or screen.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.
default TransferContactResponse	transferContact(Consumer<TransferContactRequest.Builder> transferContactRequest) Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
default TransferContactResponse	transferContact(TransferContactRequest transferContactRequest) Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
default UpdateAgentStatusResponse	updateAgentStatus(Consumer<UpdateAgentStatusRequest.Builder> updateAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateAgentStatusResponse	updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateContactResponse	updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateContactResponse	updateContact(UpdateContactRequest updateContactRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateContactAttributesResponse	updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest) Creates or updates user-defined contact attributes associated with the specified contact.
default UpdateContactAttributesResponse	updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) Creates or updates user-defined contact attributes associated with the specified contact.
default UpdateContactEvaluationResponse	updateContactEvaluation(Consumer<UpdateContactEvaluationRequest.Builder> updateContactEvaluationRequest) Updates details about a contact evaluation in the specified Amazon Connect instance.
default UpdateContactEvaluationResponse	updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest) Updates details about a contact evaluation in the specified Amazon Connect instance.
default UpdateContactFlowContentResponse	updateContactFlowContent(Consumer<UpdateContactFlowContentRequest.Builder> updateContactFlowContentRequest) Updates the specified flow.
default UpdateContactFlowContentResponse	updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest) Updates the specified flow.
default UpdateContactFlowMetadataResponse	updateContactFlowMetadata(Consumer<UpdateContactFlowMetadataRequest.Builder> updateContactFlowMetadataRequest) Updates metadata about specified flow.
default UpdateContactFlowMetadataResponse	updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest) Updates metadata about specified flow.
default UpdateContactFlowModuleContentResponse	updateContactFlowModuleContent(Consumer<UpdateContactFlowModuleContentRequest.Builder> updateContactFlowModuleContentRequest) Updates specified flow module for the specified Amazon Connect instance.
default UpdateContactFlowModuleContentResponse	updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest) Updates specified flow module for the specified Amazon Connect instance.
default UpdateContactFlowModuleMetadataResponse	updateContactFlowModuleMetadata(Consumer<UpdateContactFlowModuleMetadataRequest.Builder> updateContactFlowModuleMetadataRequest) Updates metadata about specified flow module.
default UpdateContactFlowModuleMetadataResponse	updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest) Updates metadata about specified flow module.
default UpdateContactFlowNameResponse	updateContactFlowName(Consumer<UpdateContactFlowNameRequest.Builder> updateContactFlowNameRequest) The name of the flow.
default UpdateContactFlowNameResponse	updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest) The name of the flow.
default UpdateContactScheduleResponse	updateContactSchedule(Consumer<UpdateContactScheduleRequest.Builder> updateContactScheduleRequest) Updates the scheduled time of a task contact that is already scheduled.
default UpdateContactScheduleResponse	updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest) Updates the scheduled time of a task contact that is already scheduled.
default UpdateEvaluationFormResponse	updateEvaluationForm(Consumer<UpdateEvaluationFormRequest.Builder> updateEvaluationFormRequest) Updates details about a specific evaluation form version in the specified Amazon Connect instance.
default UpdateEvaluationFormResponse	updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest) Updates details about a specific evaluation form version in the specified Amazon Connect instance.
default UpdateHoursOfOperationResponse	updateHoursOfOperation(Consumer<UpdateHoursOfOperationRequest.Builder> updateHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateHoursOfOperationResponse	updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateInstanceAttributeResponse	updateInstanceAttribute(Consumer<UpdateInstanceAttributeRequest.Builder> updateInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateInstanceAttributeResponse	updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateInstanceStorageConfigResponse	updateInstanceStorageConfig(Consumer<UpdateInstanceStorageConfigRequest.Builder> updateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateInstanceStorageConfigResponse	updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateParticipantRoleConfigResponse	updateParticipantRoleConfig(Consumer<UpdateParticipantRoleConfigRequest.Builder> updateParticipantRoleConfigRequest) Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
default UpdateParticipantRoleConfigResponse	updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest) Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
default UpdatePhoneNumberResponse	updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
default UpdatePhoneNumberResponse	updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
default UpdatePromptResponse	updatePrompt(Consumer<UpdatePromptRequest.Builder> updatePromptRequest) Updates a prompt.
default UpdatePromptResponse	updatePrompt(UpdatePromptRequest updatePromptRequest) Updates a prompt.
default UpdateQueueHoursOfOperationResponse	updateQueueHoursOfOperation(Consumer<UpdateQueueHoursOfOperationRequest.Builder> updateQueueHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueHoursOfOperationResponse	updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueMaxContactsResponse	updateQueueMaxContacts(Consumer<UpdateQueueMaxContactsRequest.Builder> updateQueueMaxContactsRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueMaxContactsResponse	updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueNameResponse	updateQueueName(Consumer<UpdateQueueNameRequest.Builder> updateQueueNameRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueNameResponse	updateQueueName(UpdateQueueNameRequest updateQueueNameRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueOutboundCallerConfigResponse	updateQueueOutboundCallerConfig(Consumer<UpdateQueueOutboundCallerConfigRequest.Builder> updateQueueOutboundCallerConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueOutboundCallerConfigResponse	updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueStatusResponse	updateQueueStatus(Consumer<UpdateQueueStatusRequest.Builder> updateQueueStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQueueStatusResponse	updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateQuickConnectConfigResponse	updateQuickConnectConfig(Consumer<UpdateQuickConnectConfigRequest.Builder> updateQuickConnectConfigRequest) Updates the configuration settings for the specified quick connect.
default UpdateQuickConnectConfigResponse	updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest) Updates the configuration settings for the specified quick connect.
default UpdateQuickConnectNameResponse	updateQuickConnectName(Consumer<UpdateQuickConnectNameRequest.Builder> updateQuickConnectNameRequest) Updates the name and description of a quick connect.
default UpdateQuickConnectNameResponse	updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest) Updates the name and description of a quick connect.
default UpdateRoutingProfileAgentAvailabilityTimerResponse	updateRoutingProfileAgentAvailabilityTimer(Consumer<UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder> updateRoutingProfileAgentAvailabilityTimerRequest) Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
default UpdateRoutingProfileAgentAvailabilityTimerResponse	updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest) Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
default UpdateRoutingProfileConcurrencyResponse	updateRoutingProfileConcurrency(Consumer<UpdateRoutingProfileConcurrencyRequest.Builder> updateRoutingProfileConcurrencyRequest) Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
default UpdateRoutingProfileConcurrencyResponse	updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
default UpdateRoutingProfileDefaultOutboundQueueResponse	updateRoutingProfileDefaultOutboundQueue(Consumer<UpdateRoutingProfileDefaultOutboundQueueRequest.Builder> updateRoutingProfileDefaultOutboundQueueRequest) Updates the default outbound queue of a routing profile.
default UpdateRoutingProfileDefaultOutboundQueueResponse	updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) Updates the default outbound queue of a routing profile.
default UpdateRoutingProfileNameResponse	updateRoutingProfileName(Consumer<UpdateRoutingProfileNameRequest.Builder> updateRoutingProfileNameRequest) Updates the name and description of a routing profile.
default UpdateRoutingProfileNameResponse	updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) Updates the name and description of a routing profile.
default UpdateRoutingProfileQueuesResponse	updateRoutingProfileQueues(Consumer<UpdateRoutingProfileQueuesRequest.Builder> updateRoutingProfileQueuesRequest) Updates the properties associated with a set of queues for a routing profile.
default UpdateRoutingProfileQueuesResponse	updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) Updates the properties associated with a set of queues for a routing profile.
default UpdateRuleResponse	updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) Updates a rule for the specified Amazon Connect instance.
default UpdateRuleResponse	updateRule(UpdateRuleRequest updateRuleRequest) Updates a rule for the specified Amazon Connect instance.
default UpdateSecurityProfileResponse	updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateSecurityProfileResponse	updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) This API is in preview release for Amazon Connect and is subject to change.
default UpdateTaskTemplateResponse	updateTaskTemplate(Consumer<UpdateTaskTemplateRequest.Builder> updateTaskTemplateRequest) Updates details about a specific task template in the specified Amazon Connect instance.
default UpdateTaskTemplateResponse	updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest) Updates details about a specific task template in the specified Amazon Connect instance.
default UpdateTrafficDistributionResponse	updateTrafficDistribution(Consumer<UpdateTrafficDistributionRequest.Builder> updateTrafficDistributionRequest) Updates the traffic distribution for a given traffic distribution group.
default UpdateTrafficDistributionResponse	updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest) Updates the traffic distribution for a given traffic distribution group.
default UpdateUserHierarchyResponse	updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest) Assigns the specified hierarchy group to the specified user.
default UpdateUserHierarchyResponse	updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) Assigns the specified hierarchy group to the specified user.
default UpdateUserHierarchyGroupNameResponse	updateUserHierarchyGroupName(Consumer<UpdateUserHierarchyGroupNameRequest.Builder> updateUserHierarchyGroupNameRequest) Updates the name of the user hierarchy group.
default UpdateUserHierarchyGroupNameResponse	updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) Updates the name of the user hierarchy group.
default UpdateUserHierarchyStructureResponse	updateUserHierarchyStructure(Consumer<UpdateUserHierarchyStructureRequest.Builder> updateUserHierarchyStructureRequest) Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
default UpdateUserHierarchyStructureResponse	updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest) Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
default UpdateUserIdentityInfoResponse	updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest) Updates the identity information for the specified user.
default UpdateUserIdentityInfoResponse	updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) Updates the identity information for the specified user.
default UpdateUserPhoneConfigResponse	updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest) Updates the phone configuration settings for the specified user.
default UpdateUserPhoneConfigResponse	updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) Updates the phone configuration settings for the specified user.
default UpdateUserRoutingProfileResponse	updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest) Assigns the specified routing profile to the specified user.
default UpdateUserRoutingProfileResponse	updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) Assigns the specified routing profile to the specified user.
default UpdateUserSecurityProfilesResponse	updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest) Assigns the specified security profiles to the specified user.
default UpdateUserSecurityProfilesResponse	updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) Assigns the specified security profiles to the specified user.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

activateEvaluationForm

default ActivateEvaluationFormResponse activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              ResourceConflictException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

activateEvaluationFormRequest -

Returns:

Result of the ActivateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

activateEvaluationForm

default ActivateEvaluationFormResponse activateEvaluationForm(Consumer<ActivateEvaluationFormRequest.Builder> activateEvaluationFormRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              ResourceConflictException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the ActivateEvaluationFormRequest.Builder avoiding the need to create one manually via ActivateEvaluationFormRequest.builder()

Parameters:

activateEvaluationFormRequest - A Consumer that will call methods on ActivateEvaluationFormRequest.Builder to create a request.

Returns:

Result of the ActivateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateApprovedOrigin

default AssociateApprovedOriginResponse associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)
                                                         throws ResourceNotFoundException,
                                                                ResourceConflictException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ServiceQuotaExceededException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Associates an approved origin to an Amazon Connect instance.

Parameters:

associateApprovedOriginRequest -

Returns:

Result of the AssociateApprovedOrigin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateApprovedOrigin

default AssociateApprovedOriginResponse associateApprovedOrigin(Consumer<AssociateApprovedOriginRequest.Builder> associateApprovedOriginRequest)
                                                         throws ResourceNotFoundException,
                                                                ResourceConflictException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ServiceQuotaExceededException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Associates an approved origin to an Amazon Connect instance.

This is a convenience which creates an instance of the AssociateApprovedOriginRequest.Builder avoiding the need to create one manually via AssociateApprovedOriginRequest.builder()

Parameters:

associateApprovedOriginRequest - A Consumer that will call methods on AssociateApprovedOriginRequest.Builder to create a request.

Returns:

Result of the AssociateApprovedOrigin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateBot

default AssociateBotResponse associateBot(AssociateBotRequest associateBotRequest)
                                   throws ResourceNotFoundException,
                                          ResourceConflictException,
                                          InternalServiceException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          ServiceQuotaExceededException,
                                          ThrottlingException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

Parameters:

associateBotRequest -

Returns:

Result of the AssociateBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateBot

default AssociateBotResponse associateBot(Consumer<AssociateBotRequest.Builder> associateBotRequest)
                                   throws ResourceNotFoundException,
                                          ResourceConflictException,
                                          InternalServiceException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          ServiceQuotaExceededException,
                                          ThrottlingException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

This is a convenience which creates an instance of the AssociateBotRequest.Builder avoiding the need to create one manually via AssociateBotRequest.builder()

Parameters:

associateBotRequest - A Consumer that will call methods on AssociateBotRequest.Builder to create a request.

Returns:

Result of the AssociateBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateDefaultVocabulary

default AssociateDefaultVocabularyResponse associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)
                                                               throws InvalidRequestException,
                                                                      ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      ThrottlingException,
                                                                      AccessDeniedException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

Parameters:

associateDefaultVocabularyRequest -

Returns:

Result of the AssociateDefaultVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateDefaultVocabulary

default AssociateDefaultVocabularyResponse associateDefaultVocabulary(Consumer<AssociateDefaultVocabularyRequest.Builder> associateDefaultVocabularyRequest)
                                                               throws InvalidRequestException,
                                                                      ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      ThrottlingException,
                                                                      AccessDeniedException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

This is a convenience which creates an instance of the AssociateDefaultVocabularyRequest.Builder avoiding the need to create one manually via AssociateDefaultVocabularyRequest.builder()

Parameters:

associateDefaultVocabularyRequest - A Consumer that will call methods on AssociateDefaultVocabularyRequest.Builder to create a request.

Returns:

Result of the AssociateDefaultVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateInstanceStorageConfig

default AssociateInstanceStorageConfigResponse associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
                                                                       throws ResourceNotFoundException,
                                                                              ResourceConflictException,
                                                                              InternalServiceException,
                                                                              InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ThrottlingException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

Parameters:

associateInstanceStorageConfigRequest -

Returns:

Result of the AssociateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateInstanceStorageConfig

default AssociateInstanceStorageConfigResponse associateInstanceStorageConfig(Consumer<AssociateInstanceStorageConfigRequest.Builder> associateInstanceStorageConfigRequest)
                                                                       throws ResourceNotFoundException,
                                                                              ResourceConflictException,
                                                                              InternalServiceException,
                                                                              InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ThrottlingException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

This is a convenience which creates an instance of the AssociateInstanceStorageConfigRequest.Builder avoiding the need to create one manually via AssociateInstanceStorageConfigRequest.builder()

Parameters:

associateInstanceStorageConfigRequest - A Consumer that will call methods on AssociateInstanceStorageConfigRequest.Builder to create a request.

Returns:

Result of the AssociateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateLambdaFunction

default AssociateLambdaFunctionResponse associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
                                                         throws ResourceNotFoundException,
                                                                ResourceConflictException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ServiceQuotaExceededException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

associateLambdaFunctionRequest -

Returns:

Result of the AssociateLambdaFunction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateLambdaFunction

default AssociateLambdaFunctionResponse associateLambdaFunction(Consumer<AssociateLambdaFunctionRequest.Builder> associateLambdaFunctionRequest)
                                                         throws ResourceNotFoundException,
                                                                ResourceConflictException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ServiceQuotaExceededException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the AssociateLambdaFunctionRequest.Builder avoiding the need to create one manually via AssociateLambdaFunctionRequest.builder()

Parameters:

associateLambdaFunctionRequest - A Consumer that will call methods on AssociateLambdaFunctionRequest.Builder to create a request.

Returns:

Result of the AssociateLambdaFunction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateLexBot

default AssociateLexBotResponse associateLexBot(AssociateLexBotRequest associateLexBotRequest)
                                         throws ResourceNotFoundException,
                                                ResourceConflictException,
                                                InternalServiceException,
                                                InvalidRequestException,
                                                InvalidParameterException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

associateLexBotRequest -

Returns:

Result of the AssociateLexBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateLexBot

default AssociateLexBotResponse associateLexBot(Consumer<AssociateLexBotRequest.Builder> associateLexBotRequest)
                                         throws ResourceNotFoundException,
                                                ResourceConflictException,
                                                InternalServiceException,
                                                InvalidRequestException,
                                                InvalidParameterException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

This is a convenience which creates an instance of the AssociateLexBotRequest.Builder avoiding the need to create one manually via AssociateLexBotRequest.builder()

Parameters:

associateLexBotRequest - A Consumer that will call methods on AssociateLexBotRequest.Builder to create a request.

Returns:

Result of the AssociateLexBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associatePhoneNumberContactFlow

default AssociatePhoneNumberContactFlowResponse associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)
                                                                         throws InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AccessDeniedException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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.

Parameters:

associatePhoneNumberContactFlowRequest -

Returns:

Result of the AssociatePhoneNumberContactFlow operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associatePhoneNumberContactFlow

default AssociatePhoneNumberContactFlowResponse associatePhoneNumberContactFlow(Consumer<AssociatePhoneNumberContactFlowRequest.Builder> associatePhoneNumberContactFlowRequest)
                                                                         throws InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AccessDeniedException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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 is a convenience which creates an instance of the AssociatePhoneNumberContactFlowRequest.Builder avoiding the need to create one manually via AssociatePhoneNumberContactFlowRequest.builder()

Parameters:

associatePhoneNumberContactFlowRequest - A Consumer that will call methods on AssociatePhoneNumberContactFlowRequest.Builder to create a request.

Returns:

Result of the AssociatePhoneNumberContactFlow operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateQueueQuickConnects

default AssociateQueueQuickConnectsResponse associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        LimitExceededException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

Associates a set of quick connects with a queue.

Parameters:

associateQueueQuickConnectsRequest -

Returns:

Result of the AssociateQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateQueueQuickConnects

default AssociateQueueQuickConnectsResponse associateQueueQuickConnects(Consumer<AssociateQueueQuickConnectsRequest.Builder> associateQueueQuickConnectsRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        LimitExceededException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

Associates a set of quick connects with a queue.

This is a convenience which creates an instance of the AssociateQueueQuickConnectsRequest.Builder avoiding the need to create one manually via AssociateQueueQuickConnectsRequest.builder()

Parameters:

associateQueueQuickConnectsRequest - A Consumer that will call methods on AssociateQueueQuickConnectsRequest.Builder to create a request.

Returns:

Result of the AssociateQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateRoutingProfileQueues

default AssociateRoutingProfileQueuesResponse associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
                                                                     throws InvalidRequestException,
                                                                            InvalidParameterException,
                                                                            ResourceNotFoundException,
                                                                            ThrottlingException,
                                                                            InternalServiceException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

Associates a set of queues with a routing profile.

Parameters:

associateRoutingProfileQueuesRequest -

Returns:

Result of the AssociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateRoutingProfileQueues

default AssociateRoutingProfileQueuesResponse associateRoutingProfileQueues(Consumer<AssociateRoutingProfileQueuesRequest.Builder> associateRoutingProfileQueuesRequest)
                                                                     throws InvalidRequestException,
                                                                            InvalidParameterException,
                                                                            ResourceNotFoundException,
                                                                            ThrottlingException,
                                                                            InternalServiceException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

Associates a set of queues with a routing profile.

This is a convenience which creates an instance of the AssociateRoutingProfileQueuesRequest.Builder avoiding the need to create one manually via AssociateRoutingProfileQueuesRequest.builder()

Parameters:

associateRoutingProfileQueuesRequest - A Consumer that will call methods on AssociateRoutingProfileQueuesRequest.Builder to create a request.

Returns:

Result of the AssociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateSecurityKey

default AssociateSecurityKeyResponse associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)
                                                   throws ResourceNotFoundException,
                                                          ResourceConflictException,
                                                          InternalServiceException,
                                                          InvalidRequestException,
                                                          InvalidParameterException,
                                                          ServiceQuotaExceededException,
                                                          ThrottlingException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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

Associates a security key to the instance.

Parameters:

associateSecurityKeyRequest -

Returns:

Result of the AssociateSecurityKey operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateSecurityKey

default AssociateSecurityKeyResponse associateSecurityKey(Consumer<AssociateSecurityKeyRequest.Builder> associateSecurityKeyRequest)
                                                   throws ResourceNotFoundException,
                                                          ResourceConflictException,
                                                          InternalServiceException,
                                                          InvalidRequestException,
                                                          InvalidParameterException,
                                                          ServiceQuotaExceededException,
                                                          ThrottlingException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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

Associates a security key to the instance.

This is a convenience which creates an instance of the AssociateSecurityKeyRequest.Builder avoiding the need to create one manually via AssociateSecurityKeyRequest.builder()

Parameters:

associateSecurityKeyRequest - A Consumer that will call methods on AssociateSecurityKeyRequest.Builder to create a request.

Returns:

Result of the AssociateSecurityKey operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateTrafficDistributionGroupUser

default AssociateTrafficDistributionGroupUserResponse associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)
                                                                                     throws InvalidRequestException,
                                                                                            AccessDeniedException,
                                                                                            ThrottlingException,
                                                                                            ResourceNotFoundException,
                                                                                            ResourceConflictException,
                                                                                            InternalServiceException,
                                                                                            AwsServiceException,
                                                                                            SdkClientException,
                                                                                            ConnectException

Associates an agent with a traffic distribution group.

Parameters:

associateTrafficDistributionGroupUserRequest -

Returns:

Result of the AssociateTrafficDistributionGroupUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateTrafficDistributionGroupUser

default AssociateTrafficDistributionGroupUserResponse associateTrafficDistributionGroupUser(Consumer<AssociateTrafficDistributionGroupUserRequest.Builder> associateTrafficDistributionGroupUserRequest)
                                                                                     throws InvalidRequestException,
                                                                                            AccessDeniedException,
                                                                                            ThrottlingException,
                                                                                            ResourceNotFoundException,
                                                                                            ResourceConflictException,
                                                                                            InternalServiceException,
                                                                                            AwsServiceException,
                                                                                            SdkClientException,
                                                                                            ConnectException

Associates an agent with a traffic distribution group.

This is a convenience which creates an instance of the AssociateTrafficDistributionGroupUserRequest.Builder avoiding the need to create one manually via AssociateTrafficDistributionGroupUserRequest.builder()

Parameters:

associateTrafficDistributionGroupUserRequest - A Consumer that will call methods on AssociateTrafficDistributionGroupUserRequest.Builder to create a request.

Returns:

Result of the AssociateTrafficDistributionGroupUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

claimPhoneNumber

default ClaimPhoneNumberResponse claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest)
                                           throws InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  IdempotencyException,
                                                  AccessDeniedException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

claimPhoneNumberRequest -

Returns:

Result of the ClaimPhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

claimPhoneNumber

default ClaimPhoneNumberResponse claimPhoneNumber(Consumer<ClaimPhoneNumberRequest.Builder> claimPhoneNumberRequest)
                                           throws InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  IdempotencyException,
                                                  AccessDeniedException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the ClaimPhoneNumberRequest.Builder avoiding the need to create one manually via ClaimPhoneNumberRequest.builder()

Parameters:

claimPhoneNumberRequest - A Consumer that will call methods on ClaimPhoneNumberRequest.Builder to create a request.

Returns:

Result of the ClaimPhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createAgentStatus

default CreateAgentStatusResponse createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    ResourceNotFoundException,
                                                    LimitExceededException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Creates an agent status for the specified Amazon Connect instance.

Parameters:

createAgentStatusRequest -

Returns:

Result of the CreateAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createAgentStatus

default CreateAgentStatusResponse createAgentStatus(Consumer<CreateAgentStatusRequest.Builder> createAgentStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    ResourceNotFoundException,
                                                    LimitExceededException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Creates an agent status for the specified Amazon Connect instance.

This is a convenience which creates an instance of the CreateAgentStatusRequest.Builder avoiding the need to create one manually via CreateAgentStatusRequest.builder()

Parameters:

createAgentStatusRequest - A Consumer that will call methods on CreateAgentStatusRequest.Builder to create a request.

Returns:

Result of the CreateAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createContactFlow

default CreateContactFlowResponse createContactFlow(CreateContactFlowRequest createContactFlowRequest)
                                             throws InvalidRequestException,
                                                    InvalidContactFlowException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    LimitExceededException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Creates a flow for the specified Amazon Connect instance.

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

Parameters:

createContactFlowRequest -

Returns:

Result of the CreateContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createContactFlow

default CreateContactFlowResponse createContactFlow(Consumer<CreateContactFlowRequest.Builder> createContactFlowRequest)
                                             throws InvalidRequestException,
                                                    InvalidContactFlowException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    LimitExceededException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Creates a flow for the specified Amazon Connect instance.

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

This is a convenience which creates an instance of the CreateContactFlowRequest.Builder avoiding the need to create one manually via CreateContactFlowRequest.builder()

Parameters:

createContactFlowRequest - A Consumer that will call methods on CreateContactFlowRequest.Builder to create a request.

Returns:

Result of the CreateContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createContactFlowModule

default CreateContactFlowModuleResponse createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)
                                                         throws AccessDeniedException,
                                                                InvalidRequestException,
                                                                InvalidContactFlowModuleException,
                                                                InvalidParameterException,
                                                                DuplicateResourceException,
                                                                LimitExceededException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                IdempotencyException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Creates a flow module for the specified Amazon Connect instance.

Parameters:

createContactFlowModuleRequest -

Returns:

Result of the CreateContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

IdempotencyException - An entity with the same name already exists.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createContactFlowModule

default CreateContactFlowModuleResponse createContactFlowModule(Consumer<CreateContactFlowModuleRequest.Builder> createContactFlowModuleRequest)
                                                         throws AccessDeniedException,
                                                                InvalidRequestException,
                                                                InvalidContactFlowModuleException,
                                                                InvalidParameterException,
                                                                DuplicateResourceException,
                                                                LimitExceededException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                IdempotencyException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Creates a flow module for the specified Amazon Connect instance.

This is a convenience which creates an instance of the CreateContactFlowModuleRequest.Builder avoiding the need to create one manually via CreateContactFlowModuleRequest.builder()

Parameters:

createContactFlowModuleRequest - A Consumer that will call methods on CreateContactFlowModuleRequest.Builder to create a request.

Returns:

Result of the CreateContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

IdempotencyException - An entity with the same name already exists.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createEvaluationForm

default CreateEvaluationFormResponse createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest)
                                                   throws InternalServiceException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          ServiceQuotaExceededException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

createEvaluationFormRequest -

Returns:

Result of the CreateEvaluationForm operation returned by the service.

Throws:

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createEvaluationForm

default CreateEvaluationFormResponse createEvaluationForm(Consumer<CreateEvaluationFormRequest.Builder> createEvaluationFormRequest)
                                                   throws InternalServiceException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          ServiceQuotaExceededException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

This is a convenience which creates an instance of the CreateEvaluationFormRequest.Builder avoiding the need to create one manually via CreateEvaluationFormRequest.builder()

Parameters:

createEvaluationFormRequest - A Consumer that will call methods on CreateEvaluationFormRequest.Builder to create a request.

Returns:

Result of the CreateEvaluationForm operation returned by the service.

Throws:

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createHoursOfOperation

default CreateHoursOfOperationResponse createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest)
                                                       throws DuplicateResourceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              LimitExceededException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Creates hours of operation.

Parameters:

createHoursOfOperationRequest -

Returns:

Result of the CreateHoursOfOperation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createHoursOfOperation

default CreateHoursOfOperationResponse createHoursOfOperation(Consumer<CreateHoursOfOperationRequest.Builder> createHoursOfOperationRequest)
                                                       throws DuplicateResourceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              LimitExceededException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Creates hours of operation.

This is a convenience which creates an instance of the CreateHoursOfOperationRequest.Builder avoiding the need to create one manually via CreateHoursOfOperationRequest.builder()

Parameters:

createHoursOfOperationRequest - A Consumer that will call methods on CreateHoursOfOperationRequest.Builder to create a request.

Returns:

Result of the CreateHoursOfOperation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createInstance

default CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest)
                                       throws InvalidRequestException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              ResourceNotFoundException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

Parameters:

createInstanceRequest -

Returns:

Result of the CreateInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createInstance

default CreateInstanceResponse createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest)
                                       throws InvalidRequestException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              ResourceNotFoundException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

This is a convenience which creates an instance of the CreateInstanceRequest.Builder avoiding the need to create one manually via CreateInstanceRequest.builder()

Parameters:

createInstanceRequest - A Consumer that will call methods on CreateInstanceRequest.Builder to create a request.

Returns:

Result of the CreateInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createIntegrationAssociation

default CreateIntegrationAssociationResponse createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
                                                                   throws DuplicateResourceException,
                                                                          ResourceNotFoundException,
                                                                          InternalServiceException,
                                                                          InvalidRequestException,
                                                                          ThrottlingException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

Parameters:

createIntegrationAssociationRequest -

Returns:

Result of the CreateIntegrationAssociation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createIntegrationAssociation

default CreateIntegrationAssociationResponse createIntegrationAssociation(Consumer<CreateIntegrationAssociationRequest.Builder> createIntegrationAssociationRequest)
                                                                   throws DuplicateResourceException,
                                                                          ResourceNotFoundException,
                                                                          InternalServiceException,
                                                                          InvalidRequestException,
                                                                          ThrottlingException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

This is a convenience which creates an instance of the CreateIntegrationAssociationRequest.Builder avoiding the need to create one manually via CreateIntegrationAssociationRequest.builder()

Parameters:

createIntegrationAssociationRequest - A Consumer that will call methods on CreateIntegrationAssociationRequest.Builder to create a request.

Returns:

Result of the CreateIntegrationAssociation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createParticipant

default CreateParticipantResponse createParticipant(CreateParticipantRequest createParticipantRequest)
                                             throws InvalidRequestException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Parameters:

createParticipantRequest -

Returns:

Result of the CreateParticipant operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createParticipant

default CreateParticipantResponse createParticipant(Consumer<CreateParticipantRequest.Builder> createParticipantRequest)
                                             throws InvalidRequestException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

This is a convenience which creates an instance of the CreateParticipantRequest.Builder avoiding the need to create one manually via CreateParticipantRequest.builder()

Parameters:

createParticipantRequest - A Consumer that will call methods on CreateParticipantRequest.Builder to create a request.

Returns:

Result of the CreateParticipant operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createPrompt

default CreatePromptResponse createPrompt(CreatePromptRequest createPromptRequest)
                                   throws DuplicateResourceException,
                                          InvalidRequestException,
                                          InvalidParameterException,
                                          LimitExceededException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

Parameters:

createPromptRequest -

Returns:

Result of the CreatePrompt operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createPrompt

default CreatePromptResponse createPrompt(Consumer<CreatePromptRequest.Builder> createPromptRequest)
                                   throws DuplicateResourceException,
                                          InvalidRequestException,
                                          InvalidParameterException,
                                          LimitExceededException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

This is a convenience which creates an instance of the CreatePromptRequest.Builder avoiding the need to create one manually via CreatePromptRequest.builder()

Parameters:

createPromptRequest - A Consumer that will call methods on CreatePromptRequest.Builder to create a request.

Returns:

Result of the CreatePrompt operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQueue

default CreateQueueResponse createQueue(CreateQueueRequest createQueueRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        DuplicateResourceException,
                                        ResourceNotFoundException,
                                        LimitExceededException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

Parameters:

createQueueRequest -

Returns:

Result of the CreateQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQueue

default CreateQueueResponse createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        DuplicateResourceException,
                                        ResourceNotFoundException,
                                        LimitExceededException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

This is a convenience which creates an instance of the CreateQueueRequest.Builder avoiding the need to create one manually via CreateQueueRequest.builder()

Parameters:

createQueueRequest - A Consumer that will call methods on CreateQueueRequest.Builder to create a request.

Returns:

Result of the CreateQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQuickConnect

default CreateQuickConnectResponse createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      DuplicateResourceException,
                                                      ResourceNotFoundException,
                                                      LimitExceededException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Creates a quick connect for the specified Amazon Connect instance.

Parameters:

createQuickConnectRequest -

Returns:

Result of the CreateQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQuickConnect

default CreateQuickConnectResponse createQuickConnect(Consumer<CreateQuickConnectRequest.Builder> createQuickConnectRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      DuplicateResourceException,
                                                      ResourceNotFoundException,
                                                      LimitExceededException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Creates a quick connect for the specified Amazon Connect instance.

This is a convenience which creates an instance of the CreateQuickConnectRequest.Builder avoiding the need to create one manually via CreateQuickConnectRequest.builder()

Parameters:

createQuickConnectRequest - A Consumer that will call methods on CreateQuickConnectRequest.Builder to create a request.

Returns:

Result of the CreateQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRoutingProfile

default CreateRoutingProfileResponse createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          DuplicateResourceException,
                                                          ResourceNotFoundException,
                                                          LimitExceededException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Creates a new routing profile.

Parameters:

createRoutingProfileRequest -

Returns:

Result of the CreateRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRoutingProfile

default CreateRoutingProfileResponse createRoutingProfile(Consumer<CreateRoutingProfileRequest.Builder> createRoutingProfileRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          DuplicateResourceException,
                                                          ResourceNotFoundException,
                                                          LimitExceededException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Creates a new routing profile.

This is a convenience which creates an instance of the CreateRoutingProfileRequest.Builder avoiding the need to create one manually via CreateRoutingProfileRequest.builder()

Parameters:

createRoutingProfileRequest - A Consumer that will call methods on CreateRoutingProfileRequest.Builder to create a request.

Returns:

Result of the CreateRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRule

default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      ResourceConflictException,
                                      ServiceQuotaExceededException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Creates a rule for the specified Amazon Connect instance.

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

Parameters:

createRuleRequest -

Returns:

Result of the CreateRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

ServiceQuotaExceededException - The service quota has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRule

default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      ResourceConflictException,
                                      ServiceQuotaExceededException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Creates a rule for the specified Amazon Connect instance.

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

This is a convenience which creates an instance of the CreateRuleRequest.Builder avoiding the need to create one manually via CreateRuleRequest.builder()

Parameters:

createRuleRequest - A Consumer that will call methods on CreateRuleRequest.Builder to create a request.

Returns:

Result of the CreateRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

ServiceQuotaExceededException - The service quota has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createSecurityProfile

default CreateSecurityProfileResponse createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            LimitExceededException,
                                                            DuplicateResourceException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Creates a security profile.

Parameters:

createSecurityProfileRequest -

Returns:

Result of the CreateSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createSecurityProfile

default CreateSecurityProfileResponse createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            LimitExceededException,
                                                            DuplicateResourceException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Creates a security profile.

This is a convenience which creates an instance of the CreateSecurityProfileRequest.Builder avoiding the need to create one manually via CreateSecurityProfileRequest.builder()

Parameters:

createSecurityProfileRequest - A Consumer that will call methods on CreateSecurityProfileRequest.Builder to create a request.

Returns:

Result of the CreateSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createTaskTemplate

default CreateTaskTemplateResponse createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest)
                                               throws PropertyValidationException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      ServiceQuotaExceededException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

Parameters:

createTaskTemplateRequest -

Returns:

Result of the CreateTaskTemplate operation returned by the service.

Throws:

PropertyValidationException - The property is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createTaskTemplate

default CreateTaskTemplateResponse createTaskTemplate(Consumer<CreateTaskTemplateRequest.Builder> createTaskTemplateRequest)
                                               throws PropertyValidationException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      ServiceQuotaExceededException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

This is a convenience which creates an instance of the CreateTaskTemplateRequest.Builder avoiding the need to create one manually via CreateTaskTemplateRequest.builder()

Parameters:

createTaskTemplateRequest - A Consumer that will call methods on CreateTaskTemplateRequest.Builder to create a request.

Returns:

Result of the CreateTaskTemplate operation returned by the service.

Throws:

PropertyValidationException - The property is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createTrafficDistributionGroup

default CreateTrafficDistributionGroupResponse createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)
                                                                       throws InvalidRequestException,
                                                                              AccessDeniedException,
                                                                              ServiceQuotaExceededException,
                                                                              ThrottlingException,
                                                                              ResourceNotFoundException,
                                                                              InternalServiceException,
                                                                              ResourceConflictException,
                                                                              ResourceNotReadyException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

Parameters:

createTrafficDistributionGroupRequest -

Returns:

Result of the CreateTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

ResourceNotReadyException - The resource is not ready.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createTrafficDistributionGroup

default CreateTrafficDistributionGroupResponse createTrafficDistributionGroup(Consumer<CreateTrafficDistributionGroupRequest.Builder> createTrafficDistributionGroupRequest)
                                                                       throws InvalidRequestException,
                                                                              AccessDeniedException,
                                                                              ServiceQuotaExceededException,
                                                                              ThrottlingException,
                                                                              ResourceNotFoundException,
                                                                              InternalServiceException,
                                                                              ResourceConflictException,
                                                                              ResourceNotReadyException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

This is a convenience which creates an instance of the CreateTrafficDistributionGroupRequest.Builder avoiding the need to create one manually via CreateTrafficDistributionGroupRequest.builder()

Parameters:

createTrafficDistributionGroupRequest - A Consumer that will call methods on CreateTrafficDistributionGroupRequest.Builder to create a request.

Returns:

Result of the CreateTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

ResourceNotReadyException - The resource is not ready.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUseCase

default CreateUseCaseResponse createUseCase(CreateUseCaseRequest createUseCaseRequest)
                                     throws DuplicateResourceException,
                                            ResourceNotFoundException,
                                            InternalServiceException,
                                            InvalidRequestException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Creates a use case for an integration association.

Parameters:

createUseCaseRequest -

Returns:

Result of the CreateUseCase operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUseCase

default CreateUseCaseResponse createUseCase(Consumer<CreateUseCaseRequest.Builder> createUseCaseRequest)
                                     throws DuplicateResourceException,
                                            ResourceNotFoundException,
                                            InternalServiceException,
                                            InvalidRequestException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Creates a use case for an integration association.

This is a convenience which creates an instance of the CreateUseCaseRequest.Builder avoiding the need to create one manually via CreateUseCaseRequest.builder()

Parameters:

createUseCaseRequest - A Consumer that will call methods on CreateUseCaseRequest.Builder to create a request.

Returns:

Result of the CreateUseCase operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUser

default CreateUserResponse createUser(CreateUserRequest createUserRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      LimitExceededException,
                                      DuplicateResourceException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUser

default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      LimitExceededException,
                                      DuplicateResourceException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

Parameters:

createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.

Returns:

Result of the CreateUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

LimitExceededException - The allowed limit for the resource has been exceeded.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUserHierarchyGroup

default CreateUserHierarchyGroupResponse createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  DuplicateResourceException,
                                                                  LimitExceededException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Creates a new user hierarchy group.

Parameters:

createUserHierarchyGroupRequest -

Returns:

Result of the CreateUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createUserHierarchyGroup

default CreateUserHierarchyGroupResponse createUserHierarchyGroup(Consumer<CreateUserHierarchyGroupRequest.Builder> createUserHierarchyGroupRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  DuplicateResourceException,
                                                                  LimitExceededException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Creates a new user hierarchy group.

This is a convenience which creates an instance of the CreateUserHierarchyGroupRequest.Builder avoiding the need to create one manually via CreateUserHierarchyGroupRequest.builder()

Parameters:

createUserHierarchyGroupRequest - A Consumer that will call methods on CreateUserHierarchyGroupRequest.Builder to create a request.

Returns:

Result of the CreateUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

LimitExceededException - The allowed limit for the resource has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createVocabulary

default CreateVocabularyResponse createVocabulary(CreateVocabularyRequest createVocabularyRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  ThrottlingException,
                                                  AccessDeniedException,
                                                  ResourceConflictException,
                                                  ServiceQuotaExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

createVocabularyRequest -

Returns:

Result of the CreateVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

ServiceQuotaExceededException - The service quota has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createVocabulary

default CreateVocabularyResponse createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  ThrottlingException,
                                                  AccessDeniedException,
                                                  ResourceConflictException,
                                                  ServiceQuotaExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the CreateVocabularyRequest.Builder avoiding the need to create one manually via CreateVocabularyRequest.builder()

Parameters:

createVocabularyRequest - A Consumer that will call methods on CreateVocabularyRequest.Builder to create a request.

Returns:

Result of the CreateVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

ServiceQuotaExceededException - The service quota has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deactivateEvaluationForm

default DeactivateEvaluationFormResponse deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)
                                                           throws InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  ResourceConflictException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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.

Parameters:

deactivateEvaluationFormRequest -

Returns:

Result of the DeactivateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deactivateEvaluationForm

default DeactivateEvaluationFormResponse deactivateEvaluationForm(Consumer<DeactivateEvaluationFormRequest.Builder> deactivateEvaluationFormRequest)
                                                           throws InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  ResourceConflictException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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.

This is a convenience which creates an instance of the DeactivateEvaluationFormRequest.Builder avoiding the need to create one manually via DeactivateEvaluationFormRequest.builder()

Parameters:

deactivateEvaluationFormRequest - A Consumer that will call methods on DeactivateEvaluationFormRequest.Builder to create a request.

Returns:

Result of the DeactivateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactEvaluation

default DeleteContactEvaluationResponse deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Deletes a contact evaluation in the specified Amazon Connect instance.

Parameters:

deleteContactEvaluationRequest -

Returns:

Result of the DeleteContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactEvaluation

default DeleteContactEvaluationResponse deleteContactEvaluation(Consumer<DeleteContactEvaluationRequest.Builder> deleteContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Deletes a contact evaluation in the specified Amazon Connect instance.

This is a convenience which creates an instance of the DeleteContactEvaluationRequest.Builder avoiding the need to create one manually via DeleteContactEvaluationRequest.builder()

Parameters:

deleteContactEvaluationRequest - A Consumer that will call methods on DeleteContactEvaluationRequest.Builder to create a request.

Returns:

Result of the DeleteContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactFlow

default DeleteContactFlowResponse deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)
                                             throws AccessDeniedException,
                                                    InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Deletes a flow for the specified Amazon Connect instance.

Parameters:

deleteContactFlowRequest -

Returns:

Result of the DeleteContactFlow operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactFlow

default DeleteContactFlowResponse deleteContactFlow(Consumer<DeleteContactFlowRequest.Builder> deleteContactFlowRequest)
                                             throws AccessDeniedException,
                                                    InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Deletes a flow for the specified Amazon Connect instance.

This is a convenience which creates an instance of the DeleteContactFlowRequest.Builder avoiding the need to create one manually via DeleteContactFlowRequest.builder()

Parameters:

deleteContactFlowRequest - A Consumer that will call methods on DeleteContactFlowRequest.Builder to create a request.

Returns:

Result of the DeleteContactFlow operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactFlowModule

default DeleteContactFlowModuleResponse deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)
                                                         throws AccessDeniedException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Deletes the specified flow module.

Parameters:

deleteContactFlowModuleRequest -

Returns:

Result of the DeleteContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteContactFlowModule

default DeleteContactFlowModuleResponse deleteContactFlowModule(Consumer<DeleteContactFlowModuleRequest.Builder> deleteContactFlowModuleRequest)
                                                         throws AccessDeniedException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Deletes the specified flow module.

This is a convenience which creates an instance of the DeleteContactFlowModuleRequest.Builder avoiding the need to create one manually via DeleteContactFlowModuleRequest.builder()

Parameters:

deleteContactFlowModuleRequest - A Consumer that will call methods on DeleteContactFlowModuleRequest.Builder to create a request.

Returns:

Result of the DeleteContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEvaluationForm

default DeleteEvaluationFormResponse deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest)
                                                   throws InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

deleteEvaluationFormRequest -

Returns:

Result of the DeleteEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEvaluationForm

default DeleteEvaluationFormResponse deleteEvaluationForm(Consumer<DeleteEvaluationFormRequest.Builder> deleteEvaluationFormRequest)
                                                   throws InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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 is a convenience which creates an instance of the DeleteEvaluationFormRequest.Builder avoiding the need to create one manually via DeleteEvaluationFormRequest.builder()

Parameters:

deleteEvaluationFormRequest - A Consumer that will call methods on DeleteEvaluationFormRequest.Builder to create a request.

Returns:

Result of the DeleteEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteHoursOfOperation

default DeleteHoursOfOperationResponse deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Deletes an hours of operation.

Parameters:

deleteHoursOfOperationRequest -

Returns:

Result of the DeleteHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteHoursOfOperation

default DeleteHoursOfOperationResponse deleteHoursOfOperation(Consumer<DeleteHoursOfOperationRequest.Builder> deleteHoursOfOperationRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Deletes an hours of operation.

This is a convenience which creates an instance of the DeleteHoursOfOperationRequest.Builder avoiding the need to create one manually via DeleteHoursOfOperationRequest.builder()

Parameters:

deleteHoursOfOperationRequest - A Consumer that will call methods on DeleteHoursOfOperationRequest.Builder to create a request.

Returns:

Result of the DeleteHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteInstance

default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
                                       throws ResourceNotFoundException,
                                              InternalServiceException,
                                              InvalidRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

Parameters:

deleteInstanceRequest -

Returns:

Result of the DeleteInstance operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteInstance

default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
                                       throws ResourceNotFoundException,
                                              InternalServiceException,
                                              InvalidRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

This is a convenience which creates an instance of the DeleteInstanceRequest.Builder avoiding the need to create one manually via DeleteInstanceRequest.builder()

Parameters:

deleteInstanceRequest - A Consumer that will call methods on DeleteInstanceRequest.Builder to create a request.

Returns:

Result of the DeleteInstance operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteIntegrationAssociation

default DeleteIntegrationAssociationResponse deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
                                                                   throws ResourceNotFoundException,
                                                                          InternalServiceException,
                                                                          InvalidRequestException,
                                                                          ThrottlingException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

Parameters:

deleteIntegrationAssociationRequest -

Returns:

Result of the DeleteIntegrationAssociation operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteIntegrationAssociation

default DeleteIntegrationAssociationResponse deleteIntegrationAssociation(Consumer<DeleteIntegrationAssociationRequest.Builder> deleteIntegrationAssociationRequest)
                                                                   throws ResourceNotFoundException,
                                                                          InternalServiceException,
                                                                          InvalidRequestException,
                                                                          ThrottlingException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

This is a convenience which creates an instance of the DeleteIntegrationAssociationRequest.Builder avoiding the need to create one manually via DeleteIntegrationAssociationRequest.builder()

Parameters:

deleteIntegrationAssociationRequest - A Consumer that will call methods on DeleteIntegrationAssociationRequest.Builder to create a request.

Returns:

Result of the DeleteIntegrationAssociation operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deletePrompt

default DeletePromptResponse deletePrompt(DeletePromptRequest deletePromptRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Deletes a prompt.

Parameters:

deletePromptRequest -

Returns:

Result of the DeletePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deletePrompt

default DeletePromptResponse deletePrompt(Consumer<DeletePromptRequest.Builder> deletePromptRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Deletes a prompt.

This is a convenience which creates an instance of the DeletePromptRequest.Builder avoiding the need to create one manually via DeletePromptRequest.builder()

Parameters:

deletePromptRequest - A Consumer that will call methods on DeletePromptRequest.Builder to create a request.

Returns:

Result of the DeletePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQueue

default DeleteQueueResponse deleteQueue(DeleteQueueRequest deleteQueueRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ResourceInUseException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

Deletes a queue.

Parameters:

deleteQueueRequest -

Returns:

Result of the DeleteQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQueue

default DeleteQueueResponse deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ResourceInUseException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

Deletes a queue.

This is a convenience which creates an instance of the DeleteQueueRequest.Builder avoiding the need to create one manually via DeleteQueueRequest.builder()

Parameters:

deleteQueueRequest - A Consumer that will call methods on DeleteQueueRequest.Builder to create a request.

Returns:

Result of the DeleteQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQuickConnect

default DeleteQuickConnectResponse deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Deletes a quick connect.

Parameters:

deleteQuickConnectRequest -

Returns:

Result of the DeleteQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQuickConnect

default DeleteQuickConnectResponse deleteQuickConnect(Consumer<DeleteQuickConnectRequest.Builder> deleteQuickConnectRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Deletes a quick connect.

This is a convenience which creates an instance of the DeleteQuickConnectRequest.Builder avoiding the need to create one manually via DeleteQuickConnectRequest.builder()

Parameters:

deleteQuickConnectRequest - A Consumer that will call methods on DeleteQuickConnectRequest.Builder to create a request.

Returns:

Result of the DeleteQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRoutingProfile

default DeleteRoutingProfileResponse deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ResourceInUseException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Deletes a routing profile.

Parameters:

deleteRoutingProfileRequest -

Returns:

Result of the DeleteRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRoutingProfile

default DeleteRoutingProfileResponse deleteRoutingProfile(Consumer<DeleteRoutingProfileRequest.Builder> deleteRoutingProfileRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ResourceInUseException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Deletes a routing profile.

This is a convenience which creates an instance of the DeleteRoutingProfileRequest.Builder avoiding the need to create one manually via DeleteRoutingProfileRequest.builder()

Parameters:

deleteRoutingProfileRequest - A Consumer that will call methods on DeleteRoutingProfileRequest.Builder to create a request.

Returns:

Result of the DeleteRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRule

default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Deletes a rule for the specified Amazon Connect instance.

Parameters:

deleteRuleRequest -

Returns:

Result of the DeleteRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRule

default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Deletes a rule for the specified Amazon Connect instance.

This is a convenience which creates an instance of the DeleteRuleRequest.Builder avoiding the need to create one manually via DeleteRuleRequest.builder()

Parameters:

deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.

Returns:

Result of the DeleteRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSecurityProfile

default DeleteSecurityProfileResponse deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AccessDeniedException,
                                                            ResourceInUseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Deletes a security profile.

Parameters:

deleteSecurityProfileRequest -

Returns:

Result of the DeleteSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSecurityProfile

default DeleteSecurityProfileResponse deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AccessDeniedException,
                                                            ResourceInUseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Deletes a security profile.

This is a convenience which creates an instance of the DeleteSecurityProfileRequest.Builder avoiding the need to create one manually via DeleteSecurityProfileRequest.builder()

Parameters:

deleteSecurityProfileRequest - A Consumer that will call methods on DeleteSecurityProfileRequest.Builder to create a request.

Returns:

Result of the DeleteSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteTaskTemplate

default DeleteTaskTemplateResponse deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Deletes the task template.

Parameters:

deleteTaskTemplateRequest -

Returns:

Result of the DeleteTaskTemplate operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteTaskTemplate

default DeleteTaskTemplateResponse deleteTaskTemplate(Consumer<DeleteTaskTemplateRequest.Builder> deleteTaskTemplateRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Deletes the task template.

This is a convenience which creates an instance of the DeleteTaskTemplateRequest.Builder avoiding the need to create one manually via DeleteTaskTemplateRequest.builder()

Parameters:

deleteTaskTemplateRequest - A Consumer that will call methods on DeleteTaskTemplateRequest.Builder to create a request.

Returns:

Result of the DeleteTaskTemplate operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteTrafficDistributionGroup

default DeleteTrafficDistributionGroupResponse deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)
                                                                       throws InvalidRequestException,
                                                                              AccessDeniedException,
                                                                              ResourceInUseException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

Parameters:

deleteTrafficDistributionGroupRequest -

Returns:

Result of the DeleteTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteTrafficDistributionGroup

default DeleteTrafficDistributionGroupResponse deleteTrafficDistributionGroup(Consumer<DeleteTrafficDistributionGroupRequest.Builder> deleteTrafficDistributionGroupRequest)
                                                                       throws InvalidRequestException,
                                                                              AccessDeniedException,
                                                                              ResourceInUseException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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.

This is a convenience which creates an instance of the DeleteTrafficDistributionGroupRequest.Builder avoiding the need to create one manually via DeleteTrafficDistributionGroupRequest.builder()

Parameters:

deleteTrafficDistributionGroupRequest - A Consumer that will call methods on DeleteTrafficDistributionGroupRequest.Builder to create a request.

Returns:

Result of the DeleteTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUseCase

default DeleteUseCaseResponse deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)
                                     throws ResourceNotFoundException,
                                            InternalServiceException,
                                            InvalidRequestException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Deletes a use case from an integration association.

Parameters:

deleteUseCaseRequest -

Returns:

Result of the DeleteUseCase operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUseCase

default DeleteUseCaseResponse deleteUseCase(Consumer<DeleteUseCaseRequest.Builder> deleteUseCaseRequest)
                                     throws ResourceNotFoundException,
                                            InternalServiceException,
                                            InvalidRequestException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Deletes a use case from an integration association.

This is a convenience which creates an instance of the DeleteUseCaseRequest.Builder avoiding the need to create one manually via DeleteUseCaseRequest.builder()

Parameters:

deleteUseCaseRequest - A Consumer that will call methods on DeleteUseCaseRequest.Builder to create a request.

Returns:

Result of the DeleteUseCase operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUserHierarchyGroup

default DeleteUserHierarchyGroupResponse deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ResourceInUseException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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

Parameters:

deleteUserHierarchyGroupRequest -

Returns:

Result of the DeleteUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteUserHierarchyGroup

default DeleteUserHierarchyGroupResponse deleteUserHierarchyGroup(Consumer<DeleteUserHierarchyGroupRequest.Builder> deleteUserHierarchyGroupRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ResourceInUseException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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

This is a convenience which creates an instance of the DeleteUserHierarchyGroupRequest.Builder avoiding the need to create one manually via DeleteUserHierarchyGroupRequest.builder()

Parameters:

deleteUserHierarchyGroupRequest - A Consumer that will call methods on DeleteUserHierarchyGroupRequest.Builder to create a request.

Returns:

Result of the DeleteUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteVocabulary

default DeleteVocabularyResponse deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  ThrottlingException,
                                                  AccessDeniedException,
                                                  ResourceInUseException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

Deletes the vocabulary that has the given identifier.

Parameters:

deleteVocabularyRequest -

Returns:

Result of the DeleteVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteVocabulary

default DeleteVocabularyResponse deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  ThrottlingException,
                                                  AccessDeniedException,
                                                  ResourceInUseException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

Deletes the vocabulary that has the given identifier.

This is a convenience which creates an instance of the DeleteVocabularyRequest.Builder avoiding the need to create one manually via DeleteVocabularyRequest.builder()

Parameters:

deleteVocabularyRequest - A Consumer that will call methods on DeleteVocabularyRequest.Builder to create a request.

Returns:

Result of the DeleteVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceInUseException - That resource is already in use. Please try another.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeAgentStatus

default DescribeAgentStatusResponse describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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

Describes an agent status.

Parameters:

describeAgentStatusRequest -

Returns:

Result of the DescribeAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeAgentStatus

default DescribeAgentStatusResponse describeAgentStatus(Consumer<DescribeAgentStatusRequest.Builder> describeAgentStatusRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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

Describes an agent status.

This is a convenience which creates an instance of the DescribeAgentStatusRequest.Builder avoiding the need to create one manually via DescribeAgentStatusRequest.builder()

Parameters:

describeAgentStatusRequest - A Consumer that will call methods on DescribeAgentStatusRequest.Builder to create a request.

Returns:

Result of the DescribeAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContact

default DescribeContactResponse describeContact(DescribeContactRequest describeContactRequest)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                InternalServiceException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

describeContactRequest -

Returns:

Result of the DescribeContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContact

default DescribeContactResponse describeContact(Consumer<DescribeContactRequest.Builder> describeContactRequest)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                InternalServiceException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

This is a convenience which creates an instance of the DescribeContactRequest.Builder avoiding the need to create one manually via DescribeContactRequest.builder()

Parameters:

describeContactRequest - A Consumer that will call methods on DescribeContactRequest.Builder to create a request.

Returns:

Result of the DescribeContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactEvaluation

default DescribeContactEvaluationResponse describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest)
                                                             throws InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Describes a contact evaluation in the specified Amazon Connect instance.

Parameters:

describeContactEvaluationRequest -

Returns:

Result of the DescribeContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactEvaluation

default DescribeContactEvaluationResponse describeContactEvaluation(Consumer<DescribeContactEvaluationRequest.Builder> describeContactEvaluationRequest)
                                                             throws InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Describes a contact evaluation in the specified Amazon Connect instance.

This is a convenience which creates an instance of the DescribeContactEvaluationRequest.Builder avoiding the need to create one manually via DescribeContactEvaluationRequest.builder()

Parameters:

describeContactEvaluationRequest - A Consumer that will call methods on DescribeContactEvaluationRequest.Builder to create a request.

Returns:

Result of the DescribeContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactFlow

default DescribeContactFlowResponse describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ContactFlowNotPublishedException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Describes the specified flow.

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

Parameters:

describeContactFlowRequest -

Returns:

Result of the DescribeContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ContactFlowNotPublishedException - The flow has not been published.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactFlow

default DescribeContactFlowResponse describeContactFlow(Consumer<DescribeContactFlowRequest.Builder> describeContactFlowRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ContactFlowNotPublishedException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Describes the specified flow.

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

This is a convenience which creates an instance of the DescribeContactFlowRequest.Builder avoiding the need to create one manually via DescribeContactFlowRequest.builder()

Parameters:

describeContactFlowRequest - A Consumer that will call methods on DescribeContactFlowRequest.Builder to create a request.

Returns:

Result of the DescribeContactFlow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ContactFlowNotPublishedException - The flow has not been published.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactFlowModule

default DescribeContactFlowModuleResponse describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)
                                                             throws AccessDeniedException,
                                                                    InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Describes the specified flow module.

Parameters:

describeContactFlowModuleRequest -

Returns:

Result of the DescribeContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeContactFlowModule

default DescribeContactFlowModuleResponse describeContactFlowModule(Consumer<DescribeContactFlowModuleRequest.Builder> describeContactFlowModuleRequest)
                                                             throws AccessDeniedException,
                                                                    InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Describes the specified flow module.

This is a convenience which creates an instance of the DescribeContactFlowModuleRequest.Builder avoiding the need to create one manually via DescribeContactFlowModuleRequest.builder()

Parameters:

describeContactFlowModuleRequest - A Consumer that will call methods on DescribeContactFlowModuleRequest.Builder to create a request.

Returns:

Result of the DescribeContactFlowModule operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeEvaluationForm

default DescribeEvaluationFormResponse describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

describeEvaluationFormRequest -

Returns:

Result of the DescribeEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeEvaluationForm

default DescribeEvaluationFormResponse describeEvaluationForm(Consumer<DescribeEvaluationFormRequest.Builder> describeEvaluationFormRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the DescribeEvaluationFormRequest.Builder avoiding the need to create one manually via DescribeEvaluationFormRequest.builder()

Parameters:

describeEvaluationFormRequest - A Consumer that will call methods on DescribeEvaluationFormRequest.Builder to create a request.

Returns:

Result of the DescribeEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeHoursOfOperation

default DescribeHoursOfOperationResponse describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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

Describes the hours of operation.

Parameters:

describeHoursOfOperationRequest -

Returns:

Result of the DescribeHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeHoursOfOperation

default DescribeHoursOfOperationResponse describeHoursOfOperation(Consumer<DescribeHoursOfOperationRequest.Builder> describeHoursOfOperationRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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

Describes the hours of operation.

This is a convenience which creates an instance of the DescribeHoursOfOperationRequest.Builder avoiding the need to create one manually via DescribeHoursOfOperationRequest.builder()

Parameters:

describeHoursOfOperationRequest - A Consumer that will call methods on DescribeHoursOfOperationRequest.Builder to create a request.

Returns:

Result of the DescribeHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstance

default DescribeInstanceResponse describeInstance(DescribeInstanceRequest describeInstanceRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

describeInstanceRequest -

Returns:

Result of the DescribeInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstance

default DescribeInstanceResponse describeInstance(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest)
                                           throws InvalidRequestException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the DescribeInstanceRequest.Builder avoiding the need to create one manually via DescribeInstanceRequest.builder()

Parameters:

describeInstanceRequest - A Consumer that will call methods on DescribeInstanceRequest.Builder to create a request.

Returns:

Result of the DescribeInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstanceAttribute

default DescribeInstanceAttributeResponse describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
                                                             throws ResourceNotFoundException,
                                                                    InternalServiceException,
                                                                    InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ThrottlingException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

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

Describes the specified instance attribute.

Parameters:

describeInstanceAttributeRequest -

Returns:

Result of the DescribeInstanceAttribute operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstanceAttribute

default DescribeInstanceAttributeResponse describeInstanceAttribute(Consumer<DescribeInstanceAttributeRequest.Builder> describeInstanceAttributeRequest)
                                                             throws ResourceNotFoundException,
                                                                    InternalServiceException,
                                                                    InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ThrottlingException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

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

Describes the specified instance attribute.

This is a convenience which creates an instance of the DescribeInstanceAttributeRequest.Builder avoiding the need to create one manually via DescribeInstanceAttributeRequest.builder()

Parameters:

describeInstanceAttributeRequest - A Consumer that will call methods on DescribeInstanceAttributeRequest.Builder to create a request.

Returns:

Result of the DescribeInstanceAttribute operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstanceStorageConfig

default DescribeInstanceStorageConfigResponse describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
                                                                     throws ResourceNotFoundException,
                                                                            InternalServiceException,
                                                                            InvalidRequestException,
                                                                            InvalidParameterException,
                                                                            ThrottlingException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

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.

Parameters:

describeInstanceStorageConfigRequest -

Returns:

Result of the DescribeInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeInstanceStorageConfig

default DescribeInstanceStorageConfigResponse describeInstanceStorageConfig(Consumer<DescribeInstanceStorageConfigRequest.Builder> describeInstanceStorageConfigRequest)
                                                                     throws ResourceNotFoundException,
                                                                            InternalServiceException,
                                                                            InvalidRequestException,
                                                                            InvalidParameterException,
                                                                            ThrottlingException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

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.

This is a convenience which creates an instance of the DescribeInstanceStorageConfigRequest.Builder avoiding the need to create one manually via DescribeInstanceStorageConfigRequest.builder()

Parameters:

describeInstanceStorageConfigRequest - A Consumer that will call methods on DescribeInstanceStorageConfigRequest.Builder to create a request.

Returns:

Result of the DescribeInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePhoneNumber

default DescribePhoneNumberResponse describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest)
                                                 throws InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AccessDeniedException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

Parameters:

describePhoneNumberRequest -

Returns:

Result of the DescribePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePhoneNumber

default DescribePhoneNumberResponse describePhoneNumber(Consumer<DescribePhoneNumberRequest.Builder> describePhoneNumberRequest)
                                                 throws InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AccessDeniedException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

This is a convenience which creates an instance of the DescribePhoneNumberRequest.Builder avoiding the need to create one manually via DescribePhoneNumberRequest.builder()

Parameters:

describePhoneNumberRequest - A Consumer that will call methods on DescribePhoneNumberRequest.Builder to create a request.

Returns:

Result of the DescribePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePrompt

default DescribePromptResponse describePrompt(DescribePromptRequest describePromptRequest)
                                       throws InvalidRequestException,
                                              InvalidParameterException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

Describes the prompt.

Parameters:

describePromptRequest -

Returns:

Result of the DescribePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePrompt

default DescribePromptResponse describePrompt(Consumer<DescribePromptRequest.Builder> describePromptRequest)
                                       throws InvalidRequestException,
                                              InvalidParameterException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

Describes the prompt.

This is a convenience which creates an instance of the DescribePromptRequest.Builder avoiding the need to create one manually via DescribePromptRequest.builder()

Parameters:

describePromptRequest - A Consumer that will call methods on DescribePromptRequest.Builder to create a request.

Returns:

Result of the DescribePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeQueue

default DescribeQueueResponse describeQueue(DescribeQueueRequest describeQueueRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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

Describes the specified queue.

Parameters:

describeQueueRequest -

Returns:

Result of the DescribeQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeQueue

default DescribeQueueResponse describeQueue(Consumer<DescribeQueueRequest.Builder> describeQueueRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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

Describes the specified queue.

This is a convenience which creates an instance of the DescribeQueueRequest.Builder avoiding the need to create one manually via DescribeQueueRequest.builder()

Parameters:

describeQueueRequest - A Consumer that will call methods on DescribeQueueRequest.Builder to create a request.

Returns:

Result of the DescribeQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeQuickConnect

default DescribeQuickConnectResponse describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Describes the quick connect.

Parameters:

describeQuickConnectRequest -

Returns:

Result of the DescribeQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeQuickConnect

default DescribeQuickConnectResponse describeQuickConnect(Consumer<DescribeQuickConnectRequest.Builder> describeQuickConnectRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Describes the quick connect.

This is a convenience which creates an instance of the DescribeQuickConnectRequest.Builder avoiding the need to create one manually via DescribeQuickConnectRequest.builder()

Parameters:

describeQuickConnectRequest - A Consumer that will call methods on DescribeQuickConnectRequest.Builder to create a request.

Returns:

Result of the DescribeQuickConnect operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeRoutingProfile

default DescribeRoutingProfileResponse describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

Describes the specified routing profile.

Parameters:

describeRoutingProfileRequest -

Returns:

Result of the DescribeRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeRoutingProfile

default DescribeRoutingProfileResponse describeRoutingProfile(Consumer<DescribeRoutingProfileRequest.Builder> describeRoutingProfileRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

Describes the specified routing profile.

This is a convenience which creates an instance of the DescribeRoutingProfileRequest.Builder avoiding the need to create one manually via DescribeRoutingProfileRequest.builder()

Parameters:

describeRoutingProfileRequest - A Consumer that will call methods on DescribeRoutingProfileRequest.Builder to create a request.

Returns:

Result of the DescribeRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeRule

default DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest)
                                   throws InvalidRequestException,
                                          ResourceNotFoundException,
                                          InternalServiceException,
                                          ThrottlingException,
                                          AccessDeniedException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Describes a rule for the specified Amazon Connect instance.

Parameters:

describeRuleRequest -

Returns:

Result of the DescribeRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeRule

default DescribeRuleResponse describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
                                   throws InvalidRequestException,
                                          ResourceNotFoundException,
                                          InternalServiceException,
                                          ThrottlingException,
                                          AccessDeniedException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Describes a rule for the specified Amazon Connect instance.

This is a convenience which creates an instance of the DescribeRuleRequest.Builder avoiding the need to create one manually via DescribeRuleRequest.builder()

Parameters:

describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.

Returns:

Result of the DescribeRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeSecurityProfile

default DescribeSecurityProfileResponse describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Gets basic information about the security profle.

Parameters:

describeSecurityProfileRequest -

Returns:

Result of the DescribeSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeSecurityProfile

default DescribeSecurityProfileResponse describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Gets basic information about the security profle.

This is a convenience which creates an instance of the DescribeSecurityProfileRequest.Builder avoiding the need to create one manually via DescribeSecurityProfileRequest.builder()

Parameters:

describeSecurityProfileRequest - A Consumer that will call methods on DescribeSecurityProfileRequest.Builder to create a request.

Returns:

Result of the DescribeSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeTrafficDistributionGroup

default DescribeTrafficDistributionGroupResponse describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)
                                                                           throws InvalidRequestException,
                                                                                  AccessDeniedException,
                                                                                  ResourceNotFoundException,
                                                                                  InternalServiceException,
                                                                                  ThrottlingException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConnectException

Gets details and status of a traffic distribution group.

Parameters:

describeTrafficDistributionGroupRequest -

Returns:

Result of the DescribeTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeTrafficDistributionGroup

default DescribeTrafficDistributionGroupResponse describeTrafficDistributionGroup(Consumer<DescribeTrafficDistributionGroupRequest.Builder> describeTrafficDistributionGroupRequest)
                                                                           throws InvalidRequestException,
                                                                                  AccessDeniedException,
                                                                                  ResourceNotFoundException,
                                                                                  InternalServiceException,
                                                                                  ThrottlingException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConnectException

Gets details and status of a traffic distribution group.

This is a convenience which creates an instance of the DescribeTrafficDistributionGroupRequest.Builder avoiding the need to create one manually via DescribeTrafficDistributionGroupRequest.builder()

Parameters:

describeTrafficDistributionGroupRequest - A Consumer that will call methods on DescribeTrafficDistributionGroupRequest.Builder to create a request.

Returns:

Result of the DescribeTrafficDistributionGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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.

This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to create one manually via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUserHierarchyGroup

default DescribeUserHierarchyGroupResponse describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

Describes the specified hierarchy group.

Parameters:

describeUserHierarchyGroupRequest -

Returns:

Result of the DescribeUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUserHierarchyGroup

default DescribeUserHierarchyGroupResponse describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

Describes the specified hierarchy group.

This is a convenience which creates an instance of the DescribeUserHierarchyGroupRequest.Builder avoiding the need to create one manually via DescribeUserHierarchyGroupRequest.builder()

Parameters:

describeUserHierarchyGroupRequest - A Consumer that will call methods on DescribeUserHierarchyGroupRequest.Builder to create a request.

Returns:

Result of the DescribeUserHierarchyGroup operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUserHierarchyStructure

default DescribeUserHierarchyStructureResponse describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

Describes the hierarchy structure of the specified Amazon Connect instance.

Parameters:

describeUserHierarchyStructureRequest -

Returns:

Result of the DescribeUserHierarchyStructure operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUserHierarchyStructure

default DescribeUserHierarchyStructureResponse describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

Describes the hierarchy structure of the specified Amazon Connect instance.

This is a convenience which creates an instance of the DescribeUserHierarchyStructureRequest.Builder avoiding the need to create one manually via DescribeUserHierarchyStructureRequest.builder()

Parameters:

describeUserHierarchyStructureRequest - A Consumer that will call methods on DescribeUserHierarchyStructureRequest.Builder to create a request.

Returns:

Result of the DescribeUserHierarchyStructure operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeVocabulary

default DescribeVocabularyResponse describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest)
                                               throws InvalidRequestException,
                                                      ResourceNotFoundException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Describes the specified vocabulary.

Parameters:

describeVocabularyRequest -

Returns:

Result of the DescribeVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeVocabulary

default DescribeVocabularyResponse describeVocabulary(Consumer<DescribeVocabularyRequest.Builder> describeVocabularyRequest)
                                               throws InvalidRequestException,
                                                      ResourceNotFoundException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Describes the specified vocabulary.

This is a convenience which creates an instance of the DescribeVocabularyRequest.Builder avoiding the need to create one manually via DescribeVocabularyRequest.builder()

Parameters:

describeVocabularyRequest - A Consumer that will call methods on DescribeVocabularyRequest.Builder to create a request.

Returns:

Result of the DescribeVocabulary operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateApprovedOrigin

default DisassociateApprovedOriginResponse disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

Revokes access to integrated applications from Amazon Connect.

Parameters:

disassociateApprovedOriginRequest -

Returns:

Result of the DisassociateApprovedOrigin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateApprovedOrigin

default DisassociateApprovedOriginResponse disassociateApprovedOrigin(Consumer<DisassociateApprovedOriginRequest.Builder> disassociateApprovedOriginRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

Revokes access to integrated applications from Amazon Connect.

This is a convenience which creates an instance of the DisassociateApprovedOriginRequest.Builder avoiding the need to create one manually via DisassociateApprovedOriginRequest.builder()

Parameters:

disassociateApprovedOriginRequest - A Consumer that will call methods on DisassociateApprovedOriginRequest.Builder to create a request.

Returns:

Result of the DisassociateApprovedOrigin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateBot

default DisassociateBotResponse disassociateBot(DisassociateBotRequest disassociateBotRequest)
                                         throws ResourceNotFoundException,
                                                InternalServiceException,
                                                InvalidRequestException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

disassociateBotRequest -

Returns:

Result of the DisassociateBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateBot

default DisassociateBotResponse disassociateBot(Consumer<DisassociateBotRequest.Builder> disassociateBotRequest)
                                         throws ResourceNotFoundException,
                                                InternalServiceException,
                                                InvalidRequestException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

This is a convenience which creates an instance of the DisassociateBotRequest.Builder avoiding the need to create one manually via DisassociateBotRequest.builder()

Parameters:

disassociateBotRequest - A Consumer that will call methods on DisassociateBotRequest.Builder to create a request.

Returns:

Result of the DisassociateBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateInstanceStorageConfig

default DisassociateInstanceStorageConfigResponse disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    InternalServiceException,
                                                                                    InvalidRequestException,
                                                                                    InvalidParameterException,
                                                                                    ThrottlingException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConnectException

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.

Parameters:

disassociateInstanceStorageConfigRequest -

Returns:

Result of the DisassociateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateInstanceStorageConfig

default DisassociateInstanceStorageConfigResponse disassociateInstanceStorageConfig(Consumer<DisassociateInstanceStorageConfigRequest.Builder> disassociateInstanceStorageConfigRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    InternalServiceException,
                                                                                    InvalidRequestException,
                                                                                    InvalidParameterException,
                                                                                    ThrottlingException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConnectException

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.

This is a convenience which creates an instance of the DisassociateInstanceStorageConfigRequest.Builder avoiding the need to create one manually via DisassociateInstanceStorageConfigRequest.builder()

Parameters:

disassociateInstanceStorageConfigRequest - A Consumer that will call methods on DisassociateInstanceStorageConfigRequest.Builder to create a request.

Returns:

Result of the DisassociateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLambdaFunction

default DisassociateLambdaFunctionResponse disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

Parameters:

disassociateLambdaFunctionRequest -

Returns:

Result of the DisassociateLambdaFunction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLambdaFunction

default DisassociateLambdaFunctionResponse disassociateLambdaFunction(Consumer<DisassociateLambdaFunctionRequest.Builder> disassociateLambdaFunctionRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

This is a convenience which creates an instance of the DisassociateLambdaFunctionRequest.Builder avoiding the need to create one manually via DisassociateLambdaFunctionRequest.builder()

Parameters:

disassociateLambdaFunctionRequest - A Consumer that will call methods on DisassociateLambdaFunctionRequest.Builder to create a request.

Returns:

Result of the DisassociateLambdaFunction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLexBot

default DisassociateLexBotResponse disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)
                                               throws ResourceNotFoundException,
                                                      InternalServiceException,
                                                      InvalidRequestException,
                                                      InvalidParameterException,
                                                      ThrottlingException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

Parameters:

disassociateLexBotRequest -

Returns:

Result of the DisassociateLexBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLexBot

default DisassociateLexBotResponse disassociateLexBot(Consumer<DisassociateLexBotRequest.Builder> disassociateLexBotRequest)
                                               throws ResourceNotFoundException,
                                                      InternalServiceException,
                                                      InvalidRequestException,
                                                      InvalidParameterException,
                                                      ThrottlingException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

This is a convenience which creates an instance of the DisassociateLexBotRequest.Builder avoiding the need to create one manually via DisassociateLexBotRequest.builder()

Parameters:

disassociateLexBotRequest - A Consumer that will call methods on DisassociateLexBotRequest.Builder to create a request.

Returns:

Result of the DisassociateLexBot operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociatePhoneNumberContactFlow

default DisassociatePhoneNumberContactFlowResponse disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)
                                                                               throws InvalidParameterException,
                                                                                      ResourceNotFoundException,
                                                                                      ThrottlingException,
                                                                                      InternalServiceException,
                                                                                      AccessDeniedException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConnectException

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.

Parameters:

disassociatePhoneNumberContactFlowRequest -

Returns:

Result of the DisassociatePhoneNumberContactFlow operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociatePhoneNumberContactFlow

default DisassociatePhoneNumberContactFlowResponse disassociatePhoneNumberContactFlow(Consumer<DisassociatePhoneNumberContactFlowRequest.Builder> disassociatePhoneNumberContactFlowRequest)
                                                                               throws InvalidParameterException,
                                                                                      ResourceNotFoundException,
                                                                                      ThrottlingException,
                                                                                      InternalServiceException,
                                                                                      AccessDeniedException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConnectException

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 is a convenience which creates an instance of the DisassociatePhoneNumberContactFlowRequest.Builder avoiding the need to create one manually via DisassociatePhoneNumberContactFlowRequest.builder()

Parameters:

disassociatePhoneNumberContactFlowRequest - A Consumer that will call methods on DisassociatePhoneNumberContactFlowRequest.Builder to create a request.

Returns:

Result of the DisassociatePhoneNumberContactFlow operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateQueueQuickConnects

default DisassociateQueueQuickConnectsResponse disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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

Disassociates a set of quick connects from a queue.

Parameters:

disassociateQueueQuickConnectsRequest -

Returns:

Result of the DisassociateQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateQueueQuickConnects

default DisassociateQueueQuickConnectsResponse disassociateQueueQuickConnects(Consumer<DisassociateQueueQuickConnectsRequest.Builder> disassociateQueueQuickConnectsRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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

Disassociates a set of quick connects from a queue.

This is a convenience which creates an instance of the DisassociateQueueQuickConnectsRequest.Builder avoiding the need to create one manually via DisassociateQueueQuickConnectsRequest.builder()

Parameters:

disassociateQueueQuickConnectsRequest - A Consumer that will call methods on DisassociateQueueQuickConnectsRequest.Builder to create a request.

Returns:

Result of the DisassociateQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateRoutingProfileQueues

default DisassociateRoutingProfileQueuesResponse disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
                                                                           throws InvalidRequestException,
                                                                                  InvalidParameterException,
                                                                                  ResourceNotFoundException,
                                                                                  ThrottlingException,
                                                                                  InternalServiceException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConnectException

Disassociates a set of queues from a routing profile.

Parameters:

disassociateRoutingProfileQueuesRequest -

Returns:

Result of the DisassociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateRoutingProfileQueues

default DisassociateRoutingProfileQueuesResponse disassociateRoutingProfileQueues(Consumer<DisassociateRoutingProfileQueuesRequest.Builder> disassociateRoutingProfileQueuesRequest)
                                                                           throws InvalidRequestException,
                                                                                  InvalidParameterException,
                                                                                  ResourceNotFoundException,
                                                                                  ThrottlingException,
                                                                                  InternalServiceException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConnectException

Disassociates a set of queues from a routing profile.

This is a convenience which creates an instance of the DisassociateRoutingProfileQueuesRequest.Builder avoiding the need to create one manually via DisassociateRoutingProfileQueuesRequest.builder()

Parameters:

disassociateRoutingProfileQueuesRequest - A Consumer that will call methods on DisassociateRoutingProfileQueuesRequest.Builder to create a request.

Returns:

Result of the DisassociateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateSecurityKey

default DisassociateSecurityKeyResponse disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
                                                         throws ResourceNotFoundException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Deletes the specified security key.

Parameters:

disassociateSecurityKeyRequest -

Returns:

Result of the DisassociateSecurityKey operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateSecurityKey

default DisassociateSecurityKeyResponse disassociateSecurityKey(Consumer<DisassociateSecurityKeyRequest.Builder> disassociateSecurityKeyRequest)
                                                         throws ResourceNotFoundException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Deletes the specified security key.

This is a convenience which creates an instance of the DisassociateSecurityKeyRequest.Builder avoiding the need to create one manually via DisassociateSecurityKeyRequest.builder()

Parameters:

disassociateSecurityKeyRequest - A Consumer that will call methods on DisassociateSecurityKeyRequest.Builder to create a request.

Returns:

Result of the DisassociateSecurityKey operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateTrafficDistributionGroupUser

default DisassociateTrafficDistributionGroupUserResponse disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)
                                                                                           throws InvalidRequestException,
                                                                                                  AccessDeniedException,
                                                                                                  ThrottlingException,
                                                                                                  ResourceNotFoundException,
                                                                                                  ResourceConflictException,
                                                                                                  InternalServiceException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConnectException

Disassociates an agent from a traffic distribution group.

Parameters:

disassociateTrafficDistributionGroupUserRequest -

Returns:

Result of the DisassociateTrafficDistributionGroupUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateTrafficDistributionGroupUser

default DisassociateTrafficDistributionGroupUserResponse disassociateTrafficDistributionGroupUser(Consumer<DisassociateTrafficDistributionGroupUserRequest.Builder> disassociateTrafficDistributionGroupUserRequest)
                                                                                           throws InvalidRequestException,
                                                                                                  AccessDeniedException,
                                                                                                  ThrottlingException,
                                                                                                  ResourceNotFoundException,
                                                                                                  ResourceConflictException,
                                                                                                  InternalServiceException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConnectException

Disassociates an agent from a traffic distribution group.

This is a convenience which creates an instance of the DisassociateTrafficDistributionGroupUserRequest.Builder avoiding the need to create one manually via DisassociateTrafficDistributionGroupUserRequest.builder()

Parameters:

disassociateTrafficDistributionGroupUserRequest - A Consumer that will call methods on DisassociateTrafficDistributionGroupUserRequest.Builder to create a request.

Returns:

Result of the DisassociateTrafficDistributionGroupUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

dismissUserContact

default DismissUserContactResponse dismissUserContact(DismissUserContactRequest dismissUserContactRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

Parameters:

dismissUserContactRequest -

Returns:

Result of the DismissUserContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

dismissUserContact

default DismissUserContactResponse dismissUserContact(Consumer<DismissUserContactRequest.Builder> dismissUserContactRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

This is a convenience which creates an instance of the DismissUserContactRequest.Builder avoiding the need to create one manually via DismissUserContactRequest.builder()

Parameters:

dismissUserContactRequest - A Consumer that will call methods on DismissUserContactRequest.Builder to create a request.

Returns:

Result of the DismissUserContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getContactAttributes

default GetContactAttributesResponse getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
                                                   throws InvalidRequestException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Retrieves the contact attributes for the specified contact.

Parameters:

getContactAttributesRequest -

Returns:

Result of the GetContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getContactAttributes

default GetContactAttributesResponse getContactAttributes(Consumer<GetContactAttributesRequest.Builder> getContactAttributesRequest)
                                                   throws InvalidRequestException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

Retrieves the contact attributes for the specified contact.

This is a convenience which creates an instance of the GetContactAttributesRequest.Builder avoiding the need to create one manually via GetContactAttributesRequest.builder()

Parameters:

getContactAttributesRequest - A Consumer that will call methods on GetContactAttributesRequest.Builder to create a request.

Returns:

Result of the GetContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentMetricData

default GetCurrentMetricDataResponse getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          InternalServiceException,
                                                          ThrottlingException,
                                                          ResourceNotFoundException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

getCurrentMetricDataRequest -

Returns:

Result of the GetCurrentMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentMetricData

default GetCurrentMetricDataResponse getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          InternalServiceException,
                                                          ThrottlingException,
                                                          ResourceNotFoundException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder avoiding the need to create one manually via GetCurrentMetricDataRequest.builder()

Parameters:

getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.Builder to create a request.

Returns:

Result of the GetCurrentMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentMetricDataPaginator

default GetCurrentMetricDataIterable getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
                                                            throws InvalidRequestException,
                                                                   InvalidParameterException,
                                                                   InternalServiceException,
                                                                   ThrottlingException,
                                                                   ResourceNotFoundException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   ConnectException

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.

This is a variant of getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client
             .getCurrentMetricDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation.

Parameters:

getCurrentMetricDataRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentMetricDataPaginator

default GetCurrentMetricDataIterable getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
                                                            throws InvalidRequestException,
                                                                   InvalidParameterException,
                                                                   InternalServiceException,
                                                                   ThrottlingException,
                                                                   ResourceNotFoundException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   ConnectException

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.

This is a variant of getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client
             .getCurrentMetricDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation.

This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder avoiding the need to create one manually via GetCurrentMetricDataRequest.builder()

Parameters:

getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentUserData

default GetCurrentUserDataResponse getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      ResourceNotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

Parameters:

getCurrentUserDataRequest -

Returns:

Result of the GetCurrentUserData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentUserData

default GetCurrentUserDataResponse getCurrentUserData(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      ResourceNotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

This is a convenience which creates an instance of the GetCurrentUserDataRequest.Builder avoiding the need to create one manually via GetCurrentUserDataRequest.builder()

Parameters:

getCurrentUserDataRequest - A Consumer that will call methods on GetCurrentUserDataRequest.Builder to create a request.

Returns:

Result of the GetCurrentUserData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentUserDataPaginator

default GetCurrentUserDataIterable getCurrentUserDataPaginator(GetCurrentUserDataRequest getCurrentUserDataRequest)
                                                        throws InvalidRequestException,
                                                               InvalidParameterException,
                                                               InternalServiceException,
                                                               ThrottlingException,
                                                               ResourceNotFoundException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client
             .getCurrentUserDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation.

Parameters:

getCurrentUserDataRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCurrentUserDataPaginator

default GetCurrentUserDataIterable getCurrentUserDataPaginator(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest)
                                                        throws InvalidRequestException,
                                                               InvalidParameterException,
                                                               InternalServiceException,
                                                               ThrottlingException,
                                                               ResourceNotFoundException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client
             .getCurrentUserDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation.

This is a convenience which creates an instance of the GetCurrentUserDataRequest.Builder avoiding the need to create one manually via GetCurrentUserDataRequest.builder()

Parameters:

getCurrentUserDataRequest - A Consumer that will call methods on GetCurrentUserDataRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getFederationToken

default GetFederationTokenResponse getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      UserNotFoundException,
                                                      InternalServiceException,
                                                      DuplicateResourceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

Parameters:

getFederationTokenRequest -

Returns:

Result of the GetFederationToken operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

UserNotFoundException - No user with the specified credentials was found in the Amazon Connect instance.

InternalServiceException - Request processing failed because of an error or failure with the service.

DuplicateResourceException - A resource with the specified name already exists.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getFederationToken

default GetFederationTokenResponse getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      UserNotFoundException,
                                                      InternalServiceException,
                                                      DuplicateResourceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

This is a convenience which creates an instance of the GetFederationTokenRequest.Builder avoiding the need to create one manually via GetFederationTokenRequest.builder()

Parameters:

getFederationTokenRequest - A Consumer that will call methods on GetFederationTokenRequest.Builder to create a request.

Returns:

Result of the GetFederationToken operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

UserNotFoundException - No user with the specified credentials was found in the Amazon Connect instance.

InternalServiceException - Request processing failed because of an error or failure with the service.

DuplicateResourceException - A resource with the specified name already exists.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricData

default GetMetricDataResponse getMetricData(GetMetricDataRequest getMetricDataRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceException,
                                            ThrottlingException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

Parameters:

getMetricDataRequest -

Returns:

Result of the GetMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricData

default GetMetricDataResponse getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceException,
                                            ThrottlingException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

This is a convenience which creates an instance of the GetMetricDataRequest.Builder avoiding the need to create one manually via GetMetricDataRequest.builder()

Parameters:

getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.

Returns:

Result of the GetMetricData operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataPaginator

default GetMetricDataIterable getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)
                                              throws InvalidRequestException,
                                                     InvalidParameterException,
                                                     InternalServiceException,
                                                     ThrottlingException,
                                                     ResourceNotFoundException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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.

This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.

Parameters:

getMetricDataRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataPaginator

default GetMetricDataIterable getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
                                              throws InvalidRequestException,
                                                     InvalidParameterException,
                                                     InternalServiceException,
                                                     ThrottlingException,
                                                     ResourceNotFoundException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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.

This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
     for (software.amazon.awssdk.services.connect.model.GetMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.

This is a convenience which creates an instance of the GetMetricDataRequest.Builder avoiding the need to create one manually via GetMetricDataRequest.builder()

Parameters:

getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataV2

default GetMetricDataV2Response getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                InternalServiceException,
                                                ThrottlingException,
                                                ResourceNotFoundException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

getMetricDataV2Request -

Returns:

Result of the GetMetricDataV2 operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataV2

default GetMetricDataV2Response getMetricDataV2(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                InternalServiceException,
                                                ThrottlingException,
                                                ResourceNotFoundException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

This is a convenience which creates an instance of the GetMetricDataV2Request.Builder avoiding the need to create one manually via GetMetricDataV2Request.builder()

Parameters:

getMetricDataV2Request - A Consumer that will call methods on GetMetricDataV2Request.Builder to create a request.

Returns:

Result of the GetMetricDataV2 operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataV2Paginator

default GetMetricDataV2Iterable getMetricDataV2Paginator(GetMetricDataV2Request getMetricDataV2Request)
                                                  throws InvalidRequestException,
                                                         InvalidParameterException,
                                                         InternalServiceException,
                                                         ThrottlingException,
                                                         ResourceNotFoundException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         ConnectException

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.

This is a variant of getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client
             .getMetricDataV2Paginator(request);
     for (software.amazon.awssdk.services.connect.model.GetMetricDataV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation.

Parameters:

getMetricDataV2Request -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMetricDataV2Paginator

default GetMetricDataV2Iterable getMetricDataV2Paginator(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request)
                                                  throws InvalidRequestException,
                                                         InvalidParameterException,
                                                         InternalServiceException,
                                                         ThrottlingException,
                                                         ResourceNotFoundException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         ConnectException

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.

This is a variant of getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client
             .getMetricDataV2Paginator(request);
     for (software.amazon.awssdk.services.connect.model.GetMetricDataV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation.

This is a convenience which creates an instance of the GetMetricDataV2Request.Builder avoiding the need to create one manually via GetMetricDataV2Request.builder()

Parameters:

getMetricDataV2Request - A Consumer that will call methods on GetMetricDataV2Request.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPromptFile

default GetPromptFileResponse getPromptFile(GetPromptFileRequest getPromptFileRequest)
                                     throws InvalidParameterException,
                                            InvalidRequestException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Gets the prompt file.

Parameters:

getPromptFileRequest -

Returns:

Result of the GetPromptFile operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPromptFile

default GetPromptFileResponse getPromptFile(Consumer<GetPromptFileRequest.Builder> getPromptFileRequest)
                                     throws InvalidParameterException,
                                            InvalidRequestException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Gets the prompt file.

This is a convenience which creates an instance of the GetPromptFileRequest.Builder avoiding the need to create one manually via GetPromptFileRequest.builder()

Parameters:

getPromptFileRequest - A Consumer that will call methods on GetPromptFileRequest.Builder to create a request.

Returns:

Result of the GetPromptFile operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTaskTemplate

default GetTaskTemplateResponse getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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

Parameters:

getTaskTemplateRequest -

Returns:

Result of the GetTaskTemplate operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTaskTemplate

default GetTaskTemplateResponse getTaskTemplate(Consumer<GetTaskTemplateRequest.Builder> getTaskTemplateRequest)
                                         throws InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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

This is a convenience which creates an instance of the GetTaskTemplateRequest.Builder avoiding the need to create one manually via GetTaskTemplateRequest.builder()

Parameters:

getTaskTemplateRequest - A Consumer that will call methods on GetTaskTemplateRequest.Builder to create a request.

Returns:

Result of the GetTaskTemplate operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTrafficDistribution

default GetTrafficDistributionResponse getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest)
                                                       throws InvalidRequestException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              InternalServiceException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Parameters:

getTrafficDistributionRequest -

Returns:

Result of the GetTrafficDistribution operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTrafficDistribution

default GetTrafficDistributionResponse getTrafficDistribution(Consumer<GetTrafficDistributionRequest.Builder> getTrafficDistributionRequest)
                                                       throws InvalidRequestException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              InternalServiceException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

This is a convenience which creates an instance of the GetTrafficDistributionRequest.Builder avoiding the need to create one manually via GetTrafficDistributionRequest.builder()

Parameters:

getTrafficDistributionRequest - A Consumer that will call methods on GetTrafficDistributionRequest.Builder to create a request.

Returns:

Result of the GetTrafficDistribution operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAgentStatuses

default ListAgentStatusesResponse listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Lists agent statuses.

Parameters:

listAgentStatusesRequest -

Returns:

Result of the ListAgentStatuses operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAgentStatuses

default ListAgentStatusesResponse listAgentStatuses(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Lists agent statuses.

This is a convenience which creates an instance of the ListAgentStatusesRequest.Builder avoiding the need to create one manually via ListAgentStatusesRequest.builder()

Parameters:

listAgentStatusesRequest - A Consumer that will call methods on ListAgentStatusRequest.Builder to create a request.

Returns:

Result of the ListAgentStatuses operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAgentStatusesPaginator

default ListAgentStatusesIterable listAgentStatusesPaginator(ListAgentStatusesRequest listAgentStatusesRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

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

Lists agent statuses.

This is a variant of listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client
             .listAgentStatusesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation.

Parameters:

listAgentStatusesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listAgentStatusesPaginator

default ListAgentStatusesIterable listAgentStatusesPaginator(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

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

Lists agent statuses.

This is a variant of listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client
             .listAgentStatusesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation.

This is a convenience which creates an instance of the ListAgentStatusesRequest.Builder avoiding the need to create one manually via ListAgentStatusesRequest.builder()

Parameters:

listAgentStatusesRequest - A Consumer that will call methods on ListAgentStatusRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listApprovedOrigins

default ListApprovedOriginsResponse listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServiceException,
                                                        InvalidRequestException,
                                                        InvalidParameterException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

Parameters:

listApprovedOriginsRequest -

Returns:

Result of the ListApprovedOrigins operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listApprovedOrigins

default ListApprovedOriginsResponse listApprovedOrigins(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServiceException,
                                                        InvalidRequestException,
                                                        InvalidParameterException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

This is a convenience which creates an instance of the ListApprovedOriginsRequest.Builder avoiding the need to create one manually via ListApprovedOriginsRequest.builder()

Parameters:

listApprovedOriginsRequest - A Consumer that will call methods on ListApprovedOriginsRequest.Builder to create a request.

Returns:

Result of the ListApprovedOrigins operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listApprovedOriginsPaginator

default ListApprovedOriginsIterable listApprovedOriginsPaginator(ListApprovedOriginsRequest listApprovedOriginsRequest)
                                                          throws ResourceNotFoundException,
                                                                 InternalServiceException,
                                                                 InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client
             .listApprovedOriginsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation.

Parameters:

listApprovedOriginsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listApprovedOriginsPaginator

default ListApprovedOriginsIterable listApprovedOriginsPaginator(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest)
                                                          throws ResourceNotFoundException,
                                                                 InternalServiceException,
                                                                 InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client
             .listApprovedOriginsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation.

This is a convenience which creates an instance of the ListApprovedOriginsRequest.Builder avoiding the need to create one manually via ListApprovedOriginsRequest.builder()

Parameters:

listApprovedOriginsRequest - A Consumer that will call methods on ListApprovedOriginsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBots

default ListBotsResponse listBots(ListBotsRequest listBotsRequest)
                           throws ResourceNotFoundException,
                                  InternalServiceException,
                                  InvalidRequestException,
                                  ThrottlingException,
                                  AwsServiceException,
                                  SdkClientException,
                                  ConnectException

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.

Parameters:

listBotsRequest -

Returns:

Result of the ListBots operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBots

default ListBotsResponse listBots(Consumer<ListBotsRequest.Builder> listBotsRequest)
                           throws ResourceNotFoundException,
                                  InternalServiceException,
                                  InvalidRequestException,
                                  ThrottlingException,
                                  AwsServiceException,
                                  SdkClientException,
                                  ConnectException

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.

This is a convenience which creates an instance of the ListBotsRequest.Builder avoiding the need to create one manually via ListBotsRequest.builder()

Parameters:

listBotsRequest - A Consumer that will call methods on ListBotsRequest.Builder to create a request.

Returns:

Result of the ListBots operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBotsPaginator

default ListBotsIterable listBotsPaginator(ListBotsRequest listBotsRequest)
                                    throws ResourceNotFoundException,
                                           InternalServiceException,
                                           InvalidRequestException,
                                           ThrottlingException,
                                           AwsServiceException,
                                           SdkClientException,
                                           ConnectException

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.

This is a variant of listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListBotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation.

Parameters:

listBotsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBotsPaginator

default ListBotsIterable listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest)
                                    throws ResourceNotFoundException,
                                           InternalServiceException,
                                           InvalidRequestException,
                                           ThrottlingException,
                                           AwsServiceException,
                                           SdkClientException,
                                           ConnectException

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.

This is a variant of listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListBotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation.

This is a convenience which creates an instance of the ListBotsRequest.Builder avoiding the need to create one manually via ListBotsRequest.builder()

Parameters:

listBotsRequest - A Consumer that will call methods on ListBotsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactEvaluations

default ListContactEvaluationsResponse listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

Lists contact evaluations in the specified Amazon Connect instance.

Parameters:

listContactEvaluationsRequest -

Returns:

Result of the ListContactEvaluations operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactEvaluations

default ListContactEvaluationsResponse listContactEvaluations(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest)
                                                       throws InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

Lists contact evaluations in the specified Amazon Connect instance.

This is a convenience which creates an instance of the ListContactEvaluationsRequest.Builder avoiding the need to create one manually via ListContactEvaluationsRequest.builder()

Parameters:

listContactEvaluationsRequest - A Consumer that will call methods on ListContactEvaluationsRequest.Builder to create a request.

Returns:

Result of the ListContactEvaluations operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactEvaluationsPaginator

default ListContactEvaluationsIterable listContactEvaluationsPaginator(ListContactEvaluationsRequest listContactEvaluationsRequest)
                                                                throws InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

Lists contact evaluations in the specified Amazon Connect instance.

This is a variant of listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client
             .listContactEvaluationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation.

Parameters:

listContactEvaluationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactEvaluationsPaginator

default ListContactEvaluationsIterable listContactEvaluationsPaginator(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest)
                                                                throws InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

Lists contact evaluations in the specified Amazon Connect instance.

This is a variant of listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client
             .listContactEvaluationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation.

This is a convenience which creates an instance of the ListContactEvaluationsRequest.Builder avoiding the need to create one manually via ListContactEvaluationsRequest.builder()

Parameters:

listContactEvaluationsRequest - A Consumer that will call methods on ListContactEvaluationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowModules

default ListContactFlowModulesResponse listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)
                                                       throws AccessDeniedException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Parameters:

listContactFlowModulesRequest -

Returns:

Result of the ListContactFlowModules operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowModules

default ListContactFlowModulesResponse listContactFlowModules(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest)
                                                       throws AccessDeniedException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

This is a convenience which creates an instance of the ListContactFlowModulesRequest.Builder avoiding the need to create one manually via ListContactFlowModulesRequest.builder()

Parameters:

listContactFlowModulesRequest - A Consumer that will call methods on ListContactFlowModulesRequest.Builder to create a request.

Returns:

Result of the ListContactFlowModules operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowModulesPaginator

default ListContactFlowModulesIterable listContactFlowModulesPaginator(ListContactFlowModulesRequest listContactFlowModulesRequest)
                                                                throws AccessDeniedException,
                                                                       InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

This is a variant of listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client
             .listContactFlowModulesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation.

Parameters:

listContactFlowModulesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowModulesPaginator

default ListContactFlowModulesIterable listContactFlowModulesPaginator(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest)
                                                                throws AccessDeniedException,
                                                                       InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

This is a variant of listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client
             .listContactFlowModulesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation.

This is a convenience which creates an instance of the ListContactFlowModulesRequest.Builder avoiding the need to create one manually via ListContactFlowModulesRequest.builder()

Parameters:

listContactFlowModulesRequest - A Consumer that will call methods on ListContactFlowModulesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlows

default ListContactFlowsResponse listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

listContactFlowsRequest -

Returns:

Result of the ListContactFlows operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlows

default ListContactFlowsResponse listContactFlows(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the ListContactFlowsRequest.Builder avoiding the need to create one manually via ListContactFlowsRequest.builder()

Parameters:

listContactFlowsRequest - A Consumer that will call methods on ListContactFlowsRequest.Builder to create a request.

Returns:

Result of the ListContactFlows operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowsPaginator

default ListContactFlowsIterable listContactFlowsPaginator(ListContactFlowsRequest listContactFlowsRequest)
                                                    throws InvalidRequestException,
                                                           InvalidParameterException,
                                                           ResourceNotFoundException,
                                                           ThrottlingException,
                                                           InternalServiceException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client
             .listContactFlowsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactFlowsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation.

Parameters:

listContactFlowsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactFlowsPaginator

default ListContactFlowsIterable listContactFlowsPaginator(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest)
                                                    throws InvalidRequestException,
                                                           InvalidParameterException,
                                                           ResourceNotFoundException,
                                                           ThrottlingException,
                                                           InternalServiceException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client
             .listContactFlowsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactFlowsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation.

This is a convenience which creates an instance of the ListContactFlowsRequest.Builder avoiding the need to create one manually via ListContactFlowsRequest.builder()

Parameters:

listContactFlowsRequest - A Consumer that will call methods on ListContactFlowsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactReferences

default ListContactReferencesResponse listContactReferences(ListContactReferencesRequest listContactReferencesRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

Parameters:

listContactReferencesRequest -

Returns:

Result of the ListContactReferences operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactReferences

default ListContactReferencesResponse listContactReferences(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

This is a convenience which creates an instance of the ListContactReferencesRequest.Builder avoiding the need to create one manually via ListContactReferencesRequest.builder()

Parameters:

listContactReferencesRequest - A Consumer that will call methods on ListContactReferencesRequest.Builder to create a request.

Returns:

Result of the ListContactReferences operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactReferencesPaginator

default ListContactReferencesIterable listContactReferencesPaginator(ListContactReferencesRequest listContactReferencesRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     InternalServiceException,
                                                                     ThrottlingException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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.

This is a variant of listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client
             .listContactReferencesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactReferencesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation.

Parameters:

listContactReferencesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listContactReferencesPaginator

default ListContactReferencesIterable listContactReferencesPaginator(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     InternalServiceException,
                                                                     ThrottlingException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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.

This is a variant of listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client
             .listContactReferencesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListContactReferencesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation.

This is a convenience which creates an instance of the ListContactReferencesRequest.Builder avoiding the need to create one manually via ListContactReferencesRequest.builder()

Parameters:

listContactReferencesRequest - A Consumer that will call methods on ListContactReferencesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDefaultVocabularies

default ListDefaultVocabulariesResponse listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
                                                         throws InvalidRequestException,
                                                                InternalServiceException,
                                                                ThrottlingException,
                                                                AccessDeniedException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Lists the default vocabularies for the specified Amazon Connect instance.

Parameters:

listDefaultVocabulariesRequest -

Returns:

Result of the ListDefaultVocabularies operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDefaultVocabularies

default ListDefaultVocabulariesResponse listDefaultVocabularies(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest)
                                                         throws InvalidRequestException,
                                                                InternalServiceException,
                                                                ThrottlingException,
                                                                AccessDeniedException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

Lists the default vocabularies for the specified Amazon Connect instance.

This is a convenience which creates an instance of the ListDefaultVocabulariesRequest.Builder avoiding the need to create one manually via ListDefaultVocabulariesRequest.builder()

Parameters:

listDefaultVocabulariesRequest - A Consumer that will call methods on ListDefaultVocabulariesRequest.Builder to create a request.

Returns:

Result of the ListDefaultVocabularies operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDefaultVocabulariesPaginator

default ListDefaultVocabulariesIterable listDefaultVocabulariesPaginator(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)
                                                                  throws InvalidRequestException,
                                                                         InternalServiceException,
                                                                         ThrottlingException,
                                                                         AccessDeniedException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

Lists the default vocabularies for the specified Amazon Connect instance.

This is a variant of listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client
             .listDefaultVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation.

Parameters:

listDefaultVocabulariesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDefaultVocabulariesPaginator

default ListDefaultVocabulariesIterable listDefaultVocabulariesPaginator(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest)
                                                                  throws InvalidRequestException,
                                                                         InternalServiceException,
                                                                         ThrottlingException,
                                                                         AccessDeniedException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

Lists the default vocabularies for the specified Amazon Connect instance.

This is a variant of listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client
             .listDefaultVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation.

This is a convenience which creates an instance of the ListDefaultVocabulariesRequest.Builder avoiding the need to create one manually via ListDefaultVocabulariesRequest.builder()

Parameters:

listDefaultVocabulariesRequest - A Consumer that will call methods on ListDefaultVocabulariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormVersions

default ListEvaluationFormVersionsResponse listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
                                                               throws InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

Parameters:

listEvaluationFormVersionsRequest -

Returns:

Result of the ListEvaluationFormVersions operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormVersions

default ListEvaluationFormVersionsResponse listEvaluationFormVersions(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest)
                                                               throws InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

This is a convenience which creates an instance of the ListEvaluationFormVersionsRequest.Builder avoiding the need to create one manually via ListEvaluationFormVersionsRequest.builder()

Parameters:

listEvaluationFormVersionsRequest - A Consumer that will call methods on ListEvaluationFormVersionsRequest.Builder to create a request.

Returns:

Result of the ListEvaluationFormVersions operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormVersionsPaginator

default ListEvaluationFormVersionsIterable listEvaluationFormVersionsPaginator(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)
                                                                        throws InvalidParameterException,
                                                                               ResourceNotFoundException,
                                                                               ThrottlingException,
                                                                               InternalServiceException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               ConnectException

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

This is a variant of listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client
             .listEvaluationFormVersionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation.

Parameters:

listEvaluationFormVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormVersionsPaginator

default ListEvaluationFormVersionsIterable listEvaluationFormVersionsPaginator(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest)
                                                                        throws InvalidParameterException,
                                                                               ResourceNotFoundException,
                                                                               ThrottlingException,
                                                                               InternalServiceException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               ConnectException

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

This is a variant of listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client
             .listEvaluationFormVersionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation.

This is a convenience which creates an instance of the ListEvaluationFormVersionsRequest.Builder avoiding the need to create one manually via ListEvaluationFormVersionsRequest.builder()

Parameters:

listEvaluationFormVersionsRequest - A Consumer that will call methods on ListEvaluationFormVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationForms

default ListEvaluationFormsResponse listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest)
                                                 throws InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Lists evaluation forms in the specified Amazon Connect instance.

Parameters:

listEvaluationFormsRequest -

Returns:

Result of the ListEvaluationForms operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationForms

default ListEvaluationFormsResponse listEvaluationForms(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest)
                                                 throws InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Lists evaluation forms in the specified Amazon Connect instance.

This is a convenience which creates an instance of the ListEvaluationFormsRequest.Builder avoiding the need to create one manually via ListEvaluationFormsRequest.builder()

Parameters:

listEvaluationFormsRequest - A Consumer that will call methods on ListEvaluationFormsRequest.Builder to create a request.

Returns:

Result of the ListEvaluationForms operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormsPaginator

default ListEvaluationFormsIterable listEvaluationFormsPaginator(ListEvaluationFormsRequest listEvaluationFormsRequest)
                                                          throws InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

Lists evaluation forms in the specified Amazon Connect instance.

This is a variant of listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client
             .listEvaluationFormsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation.

Parameters:

listEvaluationFormsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEvaluationFormsPaginator

default ListEvaluationFormsIterable listEvaluationFormsPaginator(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest)
                                                          throws InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

Lists evaluation forms in the specified Amazon Connect instance.

This is a variant of listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client
             .listEvaluationFormsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation.

This is a convenience which creates an instance of the ListEvaluationFormsRequest.Builder avoiding the need to create one manually via ListEvaluationFormsRequest.builder()

Parameters:

listEvaluationFormsRequest - A Consumer that will call methods on ListEvaluationFormsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listHoursOfOperations

default ListHoursOfOperationsResponse listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

Parameters:

listHoursOfOperationsRequest -

Returns:

Result of the ListHoursOfOperations operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listHoursOfOperations

default ListHoursOfOperationsResponse listHoursOfOperations(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

This is a convenience which creates an instance of the ListHoursOfOperationsRequest.Builder avoiding the need to create one manually via ListHoursOfOperationsRequest.builder()

Parameters:

listHoursOfOperationsRequest - A Consumer that will call methods on ListHoursOfOperationsRequest.Builder to create a request.

Returns:

Result of the ListHoursOfOperations operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listHoursOfOperationsPaginator

default ListHoursOfOperationsIterable listHoursOfOperationsPaginator(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     InternalServiceException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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.

This is a variant of listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client
             .listHoursOfOperationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation.

Parameters:

listHoursOfOperationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listHoursOfOperationsPaginator

default ListHoursOfOperationsIterable listHoursOfOperationsPaginator(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     InternalServiceException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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.

This is a variant of listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client
             .listHoursOfOperationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation.

This is a convenience which creates an instance of the ListHoursOfOperationsRequest.Builder avoiding the need to create one manually via ListHoursOfOperationsRequest.builder()

Parameters:

listHoursOfOperationsRequest - A Consumer that will call methods on ListHoursOfOperationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceAttributes

default ListInstanceAttributesResponse listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)
                                                       throws ResourceNotFoundException,
                                                              InternalServiceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

listInstanceAttributesRequest -

Returns:

Result of the ListInstanceAttributes operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceAttributes

default ListInstanceAttributesResponse listInstanceAttributes(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest)
                                                       throws ResourceNotFoundException,
                                                              InternalServiceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the ListInstanceAttributesRequest.Builder avoiding the need to create one manually via ListInstanceAttributesRequest.builder()

Parameters:

listInstanceAttributesRequest - A Consumer that will call methods on ListInstanceAttributesRequest.Builder to create a request.

Returns:

Result of the ListInstanceAttributes operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceAttributesPaginator

default ListInstanceAttributesIterable listInstanceAttributesPaginator(ListInstanceAttributesRequest listInstanceAttributesRequest)
                                                                throws ResourceNotFoundException,
                                                                       InternalServiceException,
                                                                       InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ThrottlingException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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.

This is a variant of listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client
             .listInstanceAttributesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation.

Parameters:

listInstanceAttributesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceAttributesPaginator

default ListInstanceAttributesIterable listInstanceAttributesPaginator(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest)
                                                                throws ResourceNotFoundException,
                                                                       InternalServiceException,
                                                                       InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ThrottlingException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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.

This is a variant of listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client
             .listInstanceAttributesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation.

This is a convenience which creates an instance of the ListInstanceAttributesRequest.Builder avoiding the need to create one manually via ListInstanceAttributesRequest.builder()

Parameters:

listInstanceAttributesRequest - A Consumer that will call methods on ListInstanceAttributesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceStorageConfigs

default ListInstanceStorageConfigsResponse listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

Parameters:

listInstanceStorageConfigsRequest -

Returns:

Result of the ListInstanceStorageConfigs operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceStorageConfigs

default ListInstanceStorageConfigsResponse listInstanceStorageConfigs(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest)
                                                               throws ResourceNotFoundException,
                                                                      InternalServiceException,
                                                                      InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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.

This is a convenience which creates an instance of the ListInstanceStorageConfigsRequest.Builder avoiding the need to create one manually via ListInstanceStorageConfigsRequest.builder()

Parameters:

listInstanceStorageConfigsRequest - A Consumer that will call methods on ListInstanceStorageConfigsRequest.Builder to create a request.

Returns:

Result of the ListInstanceStorageConfigs operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceStorageConfigsPaginator

default ListInstanceStorageConfigsIterable listInstanceStorageConfigsPaginator(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
                                                                        throws ResourceNotFoundException,
                                                                               InternalServiceException,
                                                                               InvalidRequestException,
                                                                               InvalidParameterException,
                                                                               ThrottlingException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               ConnectException

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.

This is a variant of listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client
             .listInstanceStorageConfigsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation.

Parameters:

listInstanceStorageConfigsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstanceStorageConfigsPaginator

default ListInstanceStorageConfigsIterable listInstanceStorageConfigsPaginator(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest)
                                                                        throws ResourceNotFoundException,
                                                                               InternalServiceException,
                                                                               InvalidRequestException,
                                                                               InvalidParameterException,
                                                                               ThrottlingException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               ConnectException

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.

This is a variant of listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client
             .listInstanceStorageConfigsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation.

This is a convenience which creates an instance of the ListInstanceStorageConfigsRequest.Builder avoiding the need to create one manually via ListInstanceStorageConfigsRequest.builder()

Parameters:

listInstanceStorageConfigsRequest - A Consumer that will call methods on ListInstanceStorageConfigsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstances

default ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest)
                                     throws InvalidRequestException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

Parameters:

listInstancesRequest -

Returns:

Result of the ListInstances operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstances

default ListInstancesResponse listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
                                     throws InvalidRequestException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

Parameters:

listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.

Returns:

Result of the ListInstances operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstancesPaginator

default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest)
                                              throws InvalidRequestException,
                                                     InternalServiceException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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.

This is a variant of listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation.

Parameters:

listInstancesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listInstancesPaginator

default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
                                              throws InvalidRequestException,
                                                     InternalServiceException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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.

This is a variant of listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation.

This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

Parameters:

listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listIntegrationAssociations

default ListIntegrationAssociationsResponse listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
                                                                 throws ResourceNotFoundException,
                                                                        InternalServiceException,
                                                                        InvalidRequestException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

Parameters:

listIntegrationAssociationsRequest -

Returns:

Result of the ListIntegrationAssociations operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listIntegrationAssociations

default ListIntegrationAssociationsResponse listIntegrationAssociations(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest)
                                                                 throws ResourceNotFoundException,
                                                                        InternalServiceException,
                                                                        InvalidRequestException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

This is a convenience which creates an instance of the ListIntegrationAssociationsRequest.Builder avoiding the need to create one manually via ListIntegrationAssociationsRequest.builder()

Parameters:

listIntegrationAssociationsRequest - A Consumer that will call methods on ListIntegrationAssociationsRequest.Builder to create a request.

Returns:

Result of the ListIntegrationAssociations operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listIntegrationAssociationsPaginator

default ListIntegrationAssociationsIterable listIntegrationAssociationsPaginator(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
                                                                          throws ResourceNotFoundException,
                                                                                 InternalServiceException,
                                                                                 InvalidRequestException,
                                                                                 ThrottlingException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConnectException

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

This is a variant of listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client
             .listIntegrationAssociationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation.

Parameters:

listIntegrationAssociationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listIntegrationAssociationsPaginator

default ListIntegrationAssociationsIterable listIntegrationAssociationsPaginator(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest)
                                                                          throws ResourceNotFoundException,
                                                                                 InternalServiceException,
                                                                                 InvalidRequestException,
                                                                                 ThrottlingException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConnectException

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

This is a variant of listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client
             .listIntegrationAssociationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation.

This is a convenience which creates an instance of the ListIntegrationAssociationsRequest.Builder avoiding the need to create one manually via ListIntegrationAssociationsRequest.builder()

Parameters:

listIntegrationAssociationsRequest - A Consumer that will call methods on ListIntegrationAssociationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLambdaFunctions

default ListLambdaFunctionsResponse listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServiceException,
                                                        InvalidRequestException,
                                                        InvalidParameterException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

Parameters:

listLambdaFunctionsRequest -

Returns:

Result of the ListLambdaFunctions operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLambdaFunctions

default ListLambdaFunctionsResponse listLambdaFunctions(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServiceException,
                                                        InvalidRequestException,
                                                        InvalidParameterException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

This is a convenience which creates an instance of the ListLambdaFunctionsRequest.Builder avoiding the need to create one manually via ListLambdaFunctionsRequest.builder()

Parameters:

listLambdaFunctionsRequest - A Consumer that will call methods on ListLambdaFunctionsRequest.Builder to create a request.

Returns:

Result of the ListLambdaFunctions operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLambdaFunctionsPaginator

default ListLambdaFunctionsIterable listLambdaFunctionsPaginator(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
                                                          throws ResourceNotFoundException,
                                                                 InternalServiceException,
                                                                 InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client
             .listLambdaFunctionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation.

Parameters:

listLambdaFunctionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLambdaFunctionsPaginator

default ListLambdaFunctionsIterable listLambdaFunctionsPaginator(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest)
                                                          throws ResourceNotFoundException,
                                                                 InternalServiceException,
                                                                 InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client
             .listLambdaFunctionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation.

This is a convenience which creates an instance of the ListLambdaFunctionsRequest.Builder avoiding the need to create one manually via ListLambdaFunctionsRequest.builder()

Parameters:

listLambdaFunctionsRequest - A Consumer that will call methods on ListLambdaFunctionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLexBots

default ListLexBotsResponse listLexBots(ListLexBotsRequest listLexBotsRequest)
                                 throws ResourceNotFoundException,
                                        InternalServiceException,
                                        InvalidRequestException,
                                        InvalidParameterException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

Parameters:

listLexBotsRequest -

Returns:

Result of the ListLexBots operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLexBots

default ListLexBotsResponse listLexBots(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest)
                                 throws ResourceNotFoundException,
                                        InternalServiceException,
                                        InvalidRequestException,
                                        InvalidParameterException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

This is a convenience which creates an instance of the ListLexBotsRequest.Builder avoiding the need to create one manually via ListLexBotsRequest.builder()

Parameters:

listLexBotsRequest - A Consumer that will call methods on ListLexBotsRequest.Builder to create a request.

Returns:

Result of the ListLexBots operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLexBotsPaginator

default ListLexBotsIterable listLexBotsPaginator(ListLexBotsRequest listLexBotsRequest)
                                          throws ResourceNotFoundException,
                                                 InternalServiceException,
                                                 InvalidRequestException,
                                                 InvalidParameterException,
                                                 ThrottlingException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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.

This is a variant of listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListLexBotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation.

Parameters:

listLexBotsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLexBotsPaginator

default ListLexBotsIterable listLexBotsPaginator(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest)
                                          throws ResourceNotFoundException,
                                                 InternalServiceException,
                                                 InvalidRequestException,
                                                 InvalidParameterException,
                                                 ThrottlingException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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.

This is a variant of listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListLexBotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation.

This is a convenience which creates an instance of the ListLexBotsRequest.Builder avoiding the need to create one manually via ListLexBotsRequest.builder()

Parameters:

listLexBotsRequest - A Consumer that will call methods on ListLexBotsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbers

default ListPhoneNumbersResponse listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

listPhoneNumbersRequest -

Returns:

Result of the ListPhoneNumbers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbers

default ListPhoneNumbersResponse listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the ListPhoneNumbersRequest.Builder avoiding the need to create one manually via ListPhoneNumbersRequest.builder()

Parameters:

listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.Builder to create a request.

Returns:

Result of the ListPhoneNumbers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersPaginator

default ListPhoneNumbersIterable listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest)
                                                    throws InvalidRequestException,
                                                           InvalidParameterException,
                                                           ResourceNotFoundException,
                                                           ThrottlingException,
                                                           InternalServiceException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client
             .listPhoneNumbersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation.

Parameters:

listPhoneNumbersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersPaginator

default ListPhoneNumbersIterable listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)
                                                    throws InvalidRequestException,
                                                           InvalidParameterException,
                                                           ResourceNotFoundException,
                                                           ThrottlingException,
                                                           InternalServiceException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client
             .listPhoneNumbersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation.

This is a convenience which creates an instance of the ListPhoneNumbersRequest.Builder avoiding the need to create one manually via ListPhoneNumbersRequest.builder()

Parameters:

listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersV2

default ListPhoneNumbersV2Response listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
                                               throws InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

• When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

• When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

Parameters:

listPhoneNumbersV2Request -

Returns:

Result of the ListPhoneNumbersV2 operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersV2

default ListPhoneNumbersV2Response listPhoneNumbersV2(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request)
                                               throws InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

• When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

• When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

This is a convenience which creates an instance of the ListPhoneNumbersV2Request.Builder avoiding the need to create one manually via ListPhoneNumbersV2Request.builder()

Parameters:

listPhoneNumbersV2Request - A Consumer that will call methods on ListPhoneNumbersV2Request.Builder to create a request.

Returns:

Result of the ListPhoneNumbersV2 operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersV2Paginator

default ListPhoneNumbersV2Iterable listPhoneNumbersV2Paginator(ListPhoneNumbersV2Request listPhoneNumbersV2Request)
                                                        throws InvalidParameterException,
                                                               ResourceNotFoundException,
                                                               ThrottlingException,
                                                               InternalServiceException,
                                                               AccessDeniedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

• When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

• When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

This is a variant of listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client
             .listPhoneNumbersV2Paginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation.

Parameters:

listPhoneNumbersV2Request -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPhoneNumbersV2Paginator

default ListPhoneNumbersV2Iterable listPhoneNumbersV2Paginator(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request)
                                                        throws InvalidParameterException,
                                                               ResourceNotFoundException,
                                                               ThrottlingException,
                                                               InternalServiceException,
                                                               AccessDeniedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

• When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

• When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

This is a variant of listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client
             .listPhoneNumbersV2Paginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation.

This is a convenience which creates an instance of the ListPhoneNumbersV2Request.Builder avoiding the need to create one manually via ListPhoneNumbersV2Request.builder()

Parameters:

listPhoneNumbersV2Request - A Consumer that will call methods on ListPhoneNumbersV2Request.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPrompts

default ListPromptsResponse listPrompts(ListPromptsRequest listPromptsRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

Parameters:

listPromptsRequest -

Returns:

Result of the ListPrompts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPrompts

default ListPromptsResponse listPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

This is a convenience which creates an instance of the ListPromptsRequest.Builder avoiding the need to create one manually via ListPromptsRequest.builder()

Parameters:

listPromptsRequest - A Consumer that will call methods on ListPromptsRequest.Builder to create a request.

Returns:

Result of the ListPrompts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPromptsPaginator

default ListPromptsIterable listPromptsPaginator(ListPromptsRequest listPromptsRequest)
                                          throws InvalidRequestException,
                                                 InvalidParameterException,
                                                 ResourceNotFoundException,
                                                 ThrottlingException,
                                                 InternalServiceException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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

This is a variant of listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPromptsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation.

Parameters:

listPromptsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPromptsPaginator

default ListPromptsIterable listPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest)
                                          throws InvalidRequestException,
                                                 InvalidParameterException,
                                                 ResourceNotFoundException,
                                                 ThrottlingException,
                                                 InternalServiceException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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

This is a variant of listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListPromptsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation.

This is a convenience which creates an instance of the ListPromptsRequest.Builder avoiding the need to create one manually via ListPromptsRequest.builder()

Parameters:

listPromptsRequest - A Consumer that will call methods on ListPromptsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueueQuickConnects

default ListQueueQuickConnectsResponse listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Lists the quick connects associated with a queue.

Parameters:

listQueueQuickConnectsRequest -

Returns:

Result of the ListQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueueQuickConnects

default ListQueueQuickConnectsResponse listQueueQuickConnects(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Lists the quick connects associated with a queue.

This is a convenience which creates an instance of the ListQueueQuickConnectsRequest.Builder avoiding the need to create one manually via ListQueueQuickConnectsRequest.builder()

Parameters:

listQueueQuickConnectsRequest - A Consumer that will call methods on ListQueueQuickConnectsRequest.Builder to create a request.

Returns:

Result of the ListQueueQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueueQuickConnectsPaginator

default ListQueueQuickConnectsIterable listQueueQuickConnectsPaginator(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)
                                                                throws InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

Lists the quick connects associated with a queue.

This is a variant of listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client
             .listQueueQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation.

Parameters:

listQueueQuickConnectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueueQuickConnectsPaginator

default ListQueueQuickConnectsIterable listQueueQuickConnectsPaginator(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest)
                                                                throws InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

Lists the quick connects associated with a queue.

This is a variant of listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client
             .listQueueQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation.

This is a convenience which creates an instance of the ListQueueQuickConnectsRequest.Builder avoiding the need to create one manually via ListQueueQuickConnectsRequest.builder()

Parameters:

listQueueQuickConnectsRequest - A Consumer that will call methods on ListQueueQuickConnectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueues

default ListQueuesResponse listQueues(ListQueuesRequest listQueuesRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

Parameters:

listQueuesRequest -

Returns:

Result of the ListQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueues

default ListQueuesResponse listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
                               throws InvalidRequestException,
                                      InvalidParameterException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServiceException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

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.

This is a convenience which creates an instance of the ListQueuesRequest.Builder avoiding the need to create one manually via ListQueuesRequest.builder()

Parameters:

listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.

Returns:

Result of the ListQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueuesPaginator

default ListQueuesIterable listQueuesPaginator(ListQueuesRequest listQueuesRequest)
                                        throws InvalidRequestException,
                                               InvalidParameterException,
                                               ResourceNotFoundException,
                                               ThrottlingException,
                                               InternalServiceException,
                                               AwsServiceException,
                                               SdkClientException,
                                               ConnectException

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.

This is a variant of listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation.

Parameters:

listQueuesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQueuesPaginator

default ListQueuesIterable listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
                                        throws InvalidRequestException,
                                               InvalidParameterException,
                                               ResourceNotFoundException,
                                               ThrottlingException,
                                               InternalServiceException,
                                               AwsServiceException,
                                               SdkClientException,
                                               ConnectException

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.

This is a variant of listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation.

This is a convenience which creates an instance of the ListQueuesRequest.Builder avoiding the need to create one manually via ListQueuesRequest.builder()

Parameters:

listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQuickConnects

default ListQuickConnectsResponse listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Parameters:

listQuickConnectsRequest -

Returns:

Result of the ListQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQuickConnects

default ListQuickConnectsResponse listQuickConnects(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

This is a convenience which creates an instance of the ListQuickConnectsRequest.Builder avoiding the need to create one manually via ListQuickConnectsRequest.builder()

Parameters:

listQuickConnectsRequest - A Consumer that will call methods on ListQuickConnectsRequest.Builder to create a request.

Returns:

Result of the ListQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQuickConnectsPaginator

default ListQuickConnectsIterable listQuickConnectsPaginator(ListQuickConnectsRequest listQuickConnectsRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

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

This is a variant of listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client
             .listQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation.

Parameters:

listQuickConnectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQuickConnectsPaginator

default ListQuickConnectsIterable listQuickConnectsPaginator(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

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

This is a variant of listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client
             .listQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation.

This is a convenience which creates an instance of the ListQuickConnectsRequest.Builder avoiding the need to create one manually via ListQuickConnectsRequest.builder()

Parameters:

listQuickConnectsRequest - A Consumer that will call methods on ListQuickConnectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfileQueues

default ListRoutingProfileQueuesResponse listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Lists the queues associated with a routing profile.

Parameters:

listRoutingProfileQueuesRequest -

Returns:

Result of the ListRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfileQueues

default ListRoutingProfileQueuesResponse listRoutingProfileQueues(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Lists the queues associated with a routing profile.

This is a convenience which creates an instance of the ListRoutingProfileQueuesRequest.Builder avoiding the need to create one manually via ListRoutingProfileQueuesRequest.builder()

Parameters:

listRoutingProfileQueuesRequest - A Consumer that will call methods on ListRoutingProfileQueuesRequest.Builder to create a request.

Returns:

Result of the ListRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfileQueuesPaginator

default ListRoutingProfileQueuesIterable listRoutingProfileQueuesPaginator(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
                                                                    throws InvalidRequestException,
                                                                           InvalidParameterException,
                                                                           ResourceNotFoundException,
                                                                           ThrottlingException,
                                                                           InternalServiceException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           ConnectException

Lists the queues associated with a routing profile.

This is a variant of listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client
             .listRoutingProfileQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation.

Parameters:

listRoutingProfileQueuesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfileQueuesPaginator

default ListRoutingProfileQueuesIterable listRoutingProfileQueuesPaginator(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest)
                                                                    throws InvalidRequestException,
                                                                           InvalidParameterException,
                                                                           ResourceNotFoundException,
                                                                           ThrottlingException,
                                                                           InternalServiceException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           ConnectException

Lists the queues associated with a routing profile.

This is a variant of listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client
             .listRoutingProfileQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation.

This is a convenience which creates an instance of the ListRoutingProfileQueuesRequest.Builder avoiding the need to create one manually via ListRoutingProfileQueuesRequest.builder()

Parameters:

listRoutingProfileQueuesRequest - A Consumer that will call methods on ListRoutingProfileQueuesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfiles

default ListRoutingProfilesResponse listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

Parameters:

listRoutingProfilesRequest -

Returns:

Result of the ListRoutingProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfiles

default ListRoutingProfilesResponse listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

This is a convenience which creates an instance of the ListRoutingProfilesRequest.Builder avoiding the need to create one manually via ListRoutingProfilesRequest.builder()

Parameters:

listRoutingProfilesRequest - A Consumer that will call methods on ListRoutingProfilesRequest.Builder to create a request.

Returns:

Result of the ListRoutingProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfilesPaginator

default ListRoutingProfilesIterable listRoutingProfilesPaginator(ListRoutingProfilesRequest listRoutingProfilesRequest)
                                                          throws InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client
             .listRoutingProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation.

Parameters:

listRoutingProfilesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoutingProfilesPaginator

default ListRoutingProfilesIterable listRoutingProfilesPaginator(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)
                                                          throws InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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.

This is a variant of listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client
             .listRoutingProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation.

This is a convenience which creates an instance of the ListRoutingProfilesRequest.Builder avoiding the need to create one manually via ListRoutingProfilesRequest.builder()

Parameters:

listRoutingProfilesRequest - A Consumer that will call methods on ListRoutingProfilesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRules

default ListRulesResponse listRules(ListRulesRequest listRulesRequest)
                             throws InvalidRequestException,
                                    InternalServiceException,
                                    ThrottlingException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ConnectException

List all rules for the specified Amazon Connect instance.

Parameters:

listRulesRequest -

Returns:

Result of the ListRules operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRules

default ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
                             throws InvalidRequestException,
                                    InternalServiceException,
                                    ThrottlingException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ConnectException

List all rules for the specified Amazon Connect instance.

This is a convenience which creates an instance of the ListRulesRequest.Builder avoiding the need to create one manually via ListRulesRequest.builder()

Parameters:

listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.

Returns:

Result of the ListRules operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRulesPaginator

default ListRulesIterable listRulesPaginator(ListRulesRequest listRulesRequest)
                                      throws InvalidRequestException,
                                             InternalServiceException,
                                             ThrottlingException,
                                             AccessDeniedException,
                                             ResourceNotFoundException,
                                             AwsServiceException,
                                             SdkClientException,
                                             ConnectException

List all rules for the specified Amazon Connect instance.

This is a variant of listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation.

Parameters:

listRulesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRulesPaginator

default ListRulesIterable listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest)
                                      throws InvalidRequestException,
                                             InternalServiceException,
                                             ThrottlingException,
                                             AccessDeniedException,
                                             ResourceNotFoundException,
                                             AwsServiceException,
                                             SdkClientException,
                                             ConnectException

List all rules for the specified Amazon Connect instance.

This is a variant of listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation.

This is a convenience which creates an instance of the ListRulesRequest.Builder avoiding the need to create one manually via ListRulesRequest.builder()

Parameters:

listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityKeys

default ListSecurityKeysResponse listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
                                           throws ResourceNotFoundException,
                                                  InternalServiceException,
                                                  InvalidRequestException,
                                                  InvalidParameterException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

listSecurityKeysRequest -

Returns:

Result of the ListSecurityKeys operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityKeys

default ListSecurityKeysResponse listSecurityKeys(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest)
                                           throws ResourceNotFoundException,
                                                  InternalServiceException,
                                                  InvalidRequestException,
                                                  InvalidParameterException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the ListSecurityKeysRequest.Builder avoiding the need to create one manually via ListSecurityKeysRequest.builder()

Parameters:

listSecurityKeysRequest - A Consumer that will call methods on ListSecurityKeysRequest.Builder to create a request.

Returns:

Result of the ListSecurityKeys operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityKeysPaginator

default ListSecurityKeysIterable listSecurityKeysPaginator(ListSecurityKeysRequest listSecurityKeysRequest)
                                                    throws ResourceNotFoundException,
                                                           InternalServiceException,
                                                           InvalidRequestException,
                                                           InvalidParameterException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client
             .listSecurityKeysPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation.

Parameters:

listSecurityKeysRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityKeysPaginator

default ListSecurityKeysIterable listSecurityKeysPaginator(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest)
                                                    throws ResourceNotFoundException,
                                                           InternalServiceException,
                                                           InvalidRequestException,
                                                           InvalidParameterException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           ConnectException

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.

This is a variant of listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client
             .listSecurityKeysPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation.

This is a convenience which creates an instance of the ListSecurityKeysRequest.Builder avoiding the need to create one manually via ListSecurityKeysRequest.builder()

Parameters:

listSecurityKeysRequest - A Consumer that will call methods on ListSecurityKeysRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilePermissions

default ListSecurityProfilePermissionsResponse listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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

Lists the permissions granted to a security profile.

Parameters:

listSecurityProfilePermissionsRequest -

Returns:

Result of the ListSecurityProfilePermissions operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilePermissions

default ListSecurityProfilePermissionsResponse listSecurityProfilePermissions(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest)
                                                                       throws InvalidRequestException,
                                                                              InvalidParameterException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

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

Lists the permissions granted to a security profile.

This is a convenience which creates an instance of the ListSecurityProfilePermissionsRequest.Builder avoiding the need to create one manually via ListSecurityProfilePermissionsRequest.builder()

Parameters:

listSecurityProfilePermissionsRequest - A Consumer that will call methods on ListSecurityProfilePermissionsRequest.Builder to create a request.

Returns:

Result of the ListSecurityProfilePermissions operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilePermissionsPaginator

default ListSecurityProfilePermissionsIterable listSecurityProfilePermissionsPaginator(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)
                                                                                throws InvalidRequestException,
                                                                                       InvalidParameterException,
                                                                                       ResourceNotFoundException,
                                                                                       ThrottlingException,
                                                                                       InternalServiceException,
                                                                                       AwsServiceException,
                                                                                       SdkClientException,
                                                                                       ConnectException

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

Lists the permissions granted to a security profile.

This is a variant of listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client
             .listSecurityProfilePermissionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation.

Parameters:

listSecurityProfilePermissionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilePermissionsPaginator

default ListSecurityProfilePermissionsIterable listSecurityProfilePermissionsPaginator(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest)
                                                                                throws InvalidRequestException,
                                                                                       InvalidParameterException,
                                                                                       ResourceNotFoundException,
                                                                                       ThrottlingException,
                                                                                       InternalServiceException,
                                                                                       AwsServiceException,
                                                                                       SdkClientException,
                                                                                       ConnectException

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

Lists the permissions granted to a security profile.

This is a variant of listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client
             .listSecurityProfilePermissionsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation.

This is a convenience which creates an instance of the ListSecurityProfilePermissionsRequest.Builder avoiding the need to create one manually via ListSecurityProfilePermissionsRequest.builder()

Parameters:

listSecurityProfilePermissionsRequest - A Consumer that will call methods on ListSecurityProfilePermissionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfiles

default ListSecurityProfilesResponse listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

listSecurityProfilesRequest -

Returns:

Result of the ListSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfiles

default ListSecurityProfilesResponse listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

This is a convenience which creates an instance of the ListSecurityProfilesRequest.Builder avoiding the need to create one manually via ListSecurityProfilesRequest.builder()

Parameters:

listSecurityProfilesRequest - A Consumer that will call methods on ListSecurityProfilesRequest.Builder to create a request.

Returns:

Result of the ListSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilesPaginator

default ListSecurityProfilesIterable listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest)
                                                            throws InvalidRequestException,
                                                                   InvalidParameterException,
                                                                   ResourceNotFoundException,
                                                                   ThrottlingException,
                                                                   InternalServiceException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   ConnectException

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.

This is a variant of listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client
             .listSecurityProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation.

Parameters:

listSecurityProfilesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecurityProfilesPaginator

default ListSecurityProfilesIterable listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)
                                                            throws InvalidRequestException,
                                                                   InvalidParameterException,
                                                                   ResourceNotFoundException,
                                                                   ThrottlingException,
                                                                   InternalServiceException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   ConnectException

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.

This is a variant of listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client
             .listSecurityProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation.

This is a convenience which creates an instance of the ListSecurityProfilesRequest.Builder avoiding the need to create one manually via ListSecurityProfilesRequest.builder()

Parameters:

listSecurityProfilesRequest - A Consumer that will call methods on ListSecurityProfilesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        InternalServiceException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        InternalServiceException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTaskTemplates

default ListTaskTemplatesResponse listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Lists task templates for the specified Amazon Connect instance.

Parameters:

listTaskTemplatesRequest -

Returns:

Result of the ListTaskTemplates operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTaskTemplates

default ListTaskTemplatesResponse listTaskTemplates(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

Lists task templates for the specified Amazon Connect instance.

This is a convenience which creates an instance of the ListTaskTemplatesRequest.Builder avoiding the need to create one manually via ListTaskTemplatesRequest.builder()

Parameters:

listTaskTemplatesRequest - A Consumer that will call methods on ListTaskTemplatesRequest.Builder to create a request.

Returns:

Result of the ListTaskTemplates operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTaskTemplatesPaginator

default ListTaskTemplatesIterable listTaskTemplatesPaginator(ListTaskTemplatesRequest listTaskTemplatesRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

Lists task templates for the specified Amazon Connect instance.

This is a variant of listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client
             .listTaskTemplatesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation.

Parameters:

listTaskTemplatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTaskTemplatesPaginator

default ListTaskTemplatesIterable listTaskTemplatesPaginator(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest)
                                                      throws InvalidRequestException,
                                                             InvalidParameterException,
                                                             ResourceNotFoundException,
                                                             ThrottlingException,
                                                             InternalServiceException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             ConnectException

Lists task templates for the specified Amazon Connect instance.

This is a variant of listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client
             .listTaskTemplatesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation.

This is a convenience which creates an instance of the ListTaskTemplatesRequest.Builder avoiding the need to create one manually via ListTaskTemplatesRequest.builder()

Parameters:

listTaskTemplatesRequest - A Consumer that will call methods on ListTaskTemplatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupUsers

default ListTrafficDistributionGroupUsersResponse listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    InvalidRequestException,
                                                                                    AccessDeniedException,
                                                                                    ThrottlingException,
                                                                                    InternalServiceException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConnectException

Lists traffic distribution group users.

Parameters:

listTrafficDistributionGroupUsersRequest -

Returns:

Result of the ListTrafficDistributionGroupUsers operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupUsers

default ListTrafficDistributionGroupUsersResponse listTrafficDistributionGroupUsers(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    InvalidRequestException,
                                                                                    AccessDeniedException,
                                                                                    ThrottlingException,
                                                                                    InternalServiceException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConnectException

Lists traffic distribution group users.

This is a convenience which creates an instance of the ListTrafficDistributionGroupUsersRequest.Builder avoiding the need to create one manually via ListTrafficDistributionGroupUsersRequest.builder()

Parameters:

listTrafficDistributionGroupUsersRequest - A Consumer that will call methods on ListTrafficDistributionGroupUsersRequest.Builder to create a request.

Returns:

Result of the ListTrafficDistributionGroupUsers operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupUsersPaginator

default ListTrafficDistributionGroupUsersIterable listTrafficDistributionGroupUsersPaginator(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)
                                                                                      throws ResourceNotFoundException,
                                                                                             InvalidRequestException,
                                                                                             AccessDeniedException,
                                                                                             ThrottlingException,
                                                                                             InternalServiceException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConnectException

Lists traffic distribution group users.

This is a variant of listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client
             .listTrafficDistributionGroupUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation.

Parameters:

listTrafficDistributionGroupUsersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupUsersPaginator

default ListTrafficDistributionGroupUsersIterable listTrafficDistributionGroupUsersPaginator(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest)
                                                                                      throws ResourceNotFoundException,
                                                                                             InvalidRequestException,
                                                                                             AccessDeniedException,
                                                                                             ThrottlingException,
                                                                                             InternalServiceException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConnectException

Lists traffic distribution group users.

This is a variant of listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client
             .listTrafficDistributionGroupUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation.

This is a convenience which creates an instance of the ListTrafficDistributionGroupUsersRequest.Builder avoiding the need to create one manually via ListTrafficDistributionGroupUsersRequest.builder()

Parameters:

listTrafficDistributionGroupUsersRequest - A Consumer that will call methods on ListTrafficDistributionGroupUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroups

default ListTrafficDistributionGroupsResponse listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
                                                                     throws InvalidRequestException,
                                                                            AccessDeniedException,
                                                                            ThrottlingException,
                                                                            InternalServiceException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

Lists traffic distribution groups.

Parameters:

listTrafficDistributionGroupsRequest -

Returns:

Result of the ListTrafficDistributionGroups operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroups

default ListTrafficDistributionGroupsResponse listTrafficDistributionGroups(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest)
                                                                     throws InvalidRequestException,
                                                                            AccessDeniedException,
                                                                            ThrottlingException,
                                                                            InternalServiceException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConnectException

Lists traffic distribution groups.

This is a convenience which creates an instance of the ListTrafficDistributionGroupsRequest.Builder avoiding the need to create one manually via ListTrafficDistributionGroupsRequest.builder()

Parameters:

listTrafficDistributionGroupsRequest - A Consumer that will call methods on ListTrafficDistributionGroupsRequest.Builder to create a request.

Returns:

Result of the ListTrafficDistributionGroups operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupsPaginator

default ListTrafficDistributionGroupsIterable listTrafficDistributionGroupsPaginator(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)
                                                                              throws InvalidRequestException,
                                                                                     AccessDeniedException,
                                                                                     ThrottlingException,
                                                                                     InternalServiceException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     ConnectException

Lists traffic distribution groups.

This is a variant of listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client
             .listTrafficDistributionGroupsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation.

Parameters:

listTrafficDistributionGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTrafficDistributionGroupsPaginator

default ListTrafficDistributionGroupsIterable listTrafficDistributionGroupsPaginator(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest)
                                                                              throws InvalidRequestException,
                                                                                     AccessDeniedException,
                                                                                     ThrottlingException,
                                                                                     InternalServiceException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     ConnectException

Lists traffic distribution groups.

This is a variant of listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client
             .listTrafficDistributionGroupsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation.

This is a convenience which creates an instance of the ListTrafficDistributionGroupsRequest.Builder avoiding the need to create one manually via ListTrafficDistributionGroupsRequest.builder()

Parameters:

listTrafficDistributionGroupsRequest - A Consumer that will call methods on ListTrafficDistributionGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUseCases

default ListUseCasesResponse listUseCases(ListUseCasesRequest listUseCasesRequest)
                                   throws ResourceNotFoundException,
                                          InternalServiceException,
                                          InvalidRequestException,
                                          ThrottlingException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Lists the use cases for the integration association.

Parameters:

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

Returns:

Result of the ListUseCases operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUseCases

default ListUseCasesResponse listUseCases(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest)
                                   throws ResourceNotFoundException,
                                          InternalServiceException,
                                          InvalidRequestException,
                                          ThrottlingException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Lists the use cases for the integration association.

This is a convenience which creates an instance of the ListUseCasesRequest.Builder avoiding the need to create one manually via ListUseCasesRequest.builder()

Parameters:

listUseCasesRequest - A Consumer that will call methods on ListUseCasesRequest.Builder to create a request. Provides summary information about the use cases for the specified integration association.

Returns:

Result of the ListUseCases operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUseCasesPaginator

default ListUseCasesIterable listUseCasesPaginator(ListUseCasesRequest listUseCasesRequest)
                                            throws ResourceNotFoundException,
                                                   InternalServiceException,
                                                   InvalidRequestException,
                                                   ThrottlingException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   ConnectException

Lists the use cases for the integration association.

This is a variant of listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUseCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation.

Parameters:

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

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUseCasesPaginator

default ListUseCasesIterable listUseCasesPaginator(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest)
                                            throws ResourceNotFoundException,
                                                   InternalServiceException,
                                                   InvalidRequestException,
                                                   ThrottlingException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   ConnectException

Lists the use cases for the integration association.

This is a variant of listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUseCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation.

This is a convenience which creates an instance of the ListUseCasesRequest.Builder avoiding the need to create one manually via ListUseCasesRequest.builder()

Parameters:

listUseCasesRequest - A Consumer that will call methods on ListUseCasesRequest.Builder to create a request. Provides summary information about the use cases for the specified integration association.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUserHierarchyGroups

default ListUserHierarchyGroupsResponse listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

listUserHierarchyGroupsRequest -

Returns:

Result of the ListUserHierarchyGroups operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUserHierarchyGroups

default ListUserHierarchyGroupsResponse listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the ListUserHierarchyGroupsRequest.Builder avoiding the need to create one manually via ListUserHierarchyGroupsRequest.builder()

Parameters:

listUserHierarchyGroupsRequest - A Consumer that will call methods on ListUserHierarchyGroupsRequest.Builder to create a request.

Returns:

Result of the ListUserHierarchyGroups operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUserHierarchyGroupsPaginator

default ListUserHierarchyGroupsIterable listUserHierarchyGroupsPaginator(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
                                                                  throws InvalidRequestException,
                                                                         InvalidParameterException,
                                                                         ResourceNotFoundException,
                                                                         ThrottlingException,
                                                                         InternalServiceException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

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.

This is a variant of listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client
             .listUserHierarchyGroupsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation.

Parameters:

listUserHierarchyGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUserHierarchyGroupsPaginator

default ListUserHierarchyGroupsIterable listUserHierarchyGroupsPaginator(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)
                                                                  throws InvalidRequestException,
                                                                         InvalidParameterException,
                                                                         ResourceNotFoundException,
                                                                         ThrottlingException,
                                                                         InternalServiceException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

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.

This is a variant of listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client
             .listUserHierarchyGroupsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation.

This is a convenience which creates an instance of the ListUserHierarchyGroupsRequest.Builder avoiding the need to create one manually via ListUserHierarchyGroupsRequest.builder()

Parameters:

listUserHierarchyGroupsRequest - A Consumer that will call methods on ListUserHierarchyGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws InvalidRequestException,
                                    InvalidParameterException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InternalServiceException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ConnectException

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

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws InvalidRequestException,
                                    InvalidParameterException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InternalServiceException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ConnectException

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

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest)
                                      throws InvalidRequestException,
                                             InvalidParameterException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InternalServiceException,
                                             AwsServiceException,
                                             SdkClientException,
                                             ConnectException

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

This is a variant of listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation.

Parameters:

listUsersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
                                      throws InvalidRequestException,
                                             InvalidParameterException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InternalServiceException,
                                             AwsServiceException,
                                             SdkClientException,
                                             ConnectException

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

This is a variant of listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

monitorContact

default MonitorContactResponse monitorContact(MonitorContactRequest monitorContactRequest)
                                       throws InvalidRequestException,
                                              IdempotencyException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

Parameters:

monitorContactRequest -

Returns:

Result of the MonitorContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

monitorContact

default MonitorContactResponse monitorContact(Consumer<MonitorContactRequest.Builder> monitorContactRequest)
                                       throws InvalidRequestException,
                                              IdempotencyException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              InternalServiceException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ConnectException

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.

This is a convenience which creates an instance of the MonitorContactRequest.Builder avoiding the need to create one manually via MonitorContactRequest.builder()

Parameters:

monitorContactRequest - A Consumer that will call methods on MonitorContactRequest.Builder to create a request.

Returns:

Result of the MonitorContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putUserStatus

default PutUserStatusResponse putUserStatus(PutUserStatusRequest putUserStatusRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

Parameters:

putUserStatusRequest -

Returns:

Result of the PutUserStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putUserStatus

default PutUserStatusResponse putUserStatus(Consumer<PutUserStatusRequest.Builder> putUserStatusRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

This is a convenience which creates an instance of the PutUserStatusRequest.Builder avoiding the need to create one manually via PutUserStatusRequest.builder()

Parameters:

putUserStatusRequest - A Consumer that will call methods on PutUserStatusRequest.Builder to create a request.

Returns:

Result of the PutUserStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

releasePhoneNumber

default ReleasePhoneNumberResponse releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest)
                                               throws InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      ResourceInUseException,
                                                      IdempotencyException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

Parameters:

releasePhoneNumberRequest -

Returns:

Result of the ReleasePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceInUseException - That resource is already in use. Please try another.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

releasePhoneNumber

default ReleasePhoneNumberResponse releasePhoneNumber(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest)
                                               throws InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      ResourceInUseException,
                                                      IdempotencyException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

This is a convenience which creates an instance of the ReleasePhoneNumberRequest.Builder avoiding the need to create one manually via ReleasePhoneNumberRequest.builder()

Parameters:

releasePhoneNumberRequest - A Consumer that will call methods on ReleasePhoneNumberRequest.Builder to create a request.

Returns:

Result of the ReleasePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceInUseException - That resource is already in use. Please try another.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

replicateInstance

default ReplicateInstanceResponse replicateInstance(ReplicateInstanceRequest replicateInstanceRequest)
                                             throws InvalidRequestException,
                                                    AccessDeniedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ResourceNotReadyException,
                                                    ResourceConflictException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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.

Parameters:

replicateInstanceRequest -

Returns:

Result of the ReplicateInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotReadyException - The resource is not ready.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

replicateInstance

default ReplicateInstanceResponse replicateInstance(Consumer<ReplicateInstanceRequest.Builder> replicateInstanceRequest)
                                             throws InvalidRequestException,
                                                    AccessDeniedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    ResourceNotFoundException,
                                                    InternalServiceException,
                                                    ResourceNotReadyException,
                                                    ResourceConflictException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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.

This is a convenience which creates an instance of the ReplicateInstanceRequest.Builder avoiding the need to create one manually via ReplicateInstanceRequest.builder()

Parameters:

replicateInstanceRequest - A Consumer that will call methods on ReplicateInstanceRequest.Builder to create a request.

Returns:

Result of the ReplicateInstance operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotReadyException - The resource is not ready.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

resumeContactRecording

default ResumeContactRecordingResponse resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
                                                       throws InvalidRequestException,
                                                              ResourceNotFoundException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

resumeContactRecordingRequest -

Returns:

Result of the ResumeContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

resumeContactRecording

default ResumeContactRecordingResponse resumeContactRecording(Consumer<ResumeContactRecordingRequest.Builder> resumeContactRecordingRequest)
                                                       throws InvalidRequestException,
                                                              ResourceNotFoundException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the ResumeContactRecordingRequest.Builder avoiding the need to create one manually via ResumeContactRecordingRequest.builder()

Parameters:

resumeContactRecordingRequest - A Consumer that will call methods on ResumeContactRecordingRequest.Builder to create a request.

Returns:

Result of the ResumeContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchAvailablePhoneNumbers

default SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
                                                                 throws InvalidParameterException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AccessDeniedException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

Parameters:

searchAvailablePhoneNumbersRequest -

Returns:

Result of the SearchAvailablePhoneNumbers operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchAvailablePhoneNumbers

default SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)
                                                                 throws InvalidParameterException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AccessDeniedException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

This is a convenience which creates an instance of the SearchAvailablePhoneNumbersRequest.Builder avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()

Parameters:

searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.Builder to create a request.

Returns:

Result of the SearchAvailablePhoneNumbers operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchAvailablePhoneNumbersPaginator

default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
                                                                          throws InvalidParameterException,
                                                                                 ThrottlingException,
                                                                                 InternalServiceException,
                                                                                 AccessDeniedException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConnectException

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.

This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client
             .searchAvailablePhoneNumbersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation.

Parameters:

searchAvailablePhoneNumbersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchAvailablePhoneNumbersPaginator

default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)
                                                                          throws InvalidParameterException,
                                                                                 ThrottlingException,
                                                                                 InternalServiceException,
                                                                                 AccessDeniedException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConnectException

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.

This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client
             .searchAvailablePhoneNumbersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation.

This is a convenience which creates an instance of the SearchAvailablePhoneNumbersRequest.Builder avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()

Parameters:

searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchHoursOfOperations

default SearchHoursOfOperationsResponse searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Parameters:

searchHoursOfOperationsRequest -

Returns:

Result of the SearchHoursOfOperations operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchHoursOfOperations

default SearchHoursOfOperationsResponse searchHoursOfOperations(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

This is a convenience which creates an instance of the SearchHoursOfOperationsRequest.Builder avoiding the need to create one manually via SearchHoursOfOperationsRequest.builder()

Parameters:

searchHoursOfOperationsRequest - A Consumer that will call methods on SearchHoursOfOperationsRequest.Builder to create a request.

Returns:

Result of the SearchHoursOfOperations operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchHoursOfOperationsPaginator

default SearchHoursOfOperationsIterable searchHoursOfOperationsPaginator(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)
                                                                  throws InvalidRequestException,
                                                                         InvalidParameterException,
                                                                         ResourceNotFoundException,
                                                                         ThrottlingException,
                                                                         InternalServiceException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

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

This is a variant of searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client
             .searchHoursOfOperationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation.

Parameters:

searchHoursOfOperationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchHoursOfOperationsPaginator

default SearchHoursOfOperationsIterable searchHoursOfOperationsPaginator(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest)
                                                                  throws InvalidRequestException,
                                                                         InvalidParameterException,
                                                                         ResourceNotFoundException,
                                                                         ThrottlingException,
                                                                         InternalServiceException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConnectException

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

This is a variant of searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client
             .searchHoursOfOperationsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation.

This is a convenience which creates an instance of the SearchHoursOfOperationsRequest.Builder avoiding the need to create one manually via SearchHoursOfOperationsRequest.builder()

Parameters:

searchHoursOfOperationsRequest - A Consumer that will call methods on SearchHoursOfOperationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchPrompts

default SearchPromptsResponse searchPrompts(SearchPromptsRequest searchPromptsRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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

Parameters:

searchPromptsRequest -

Returns:

Result of the SearchPrompts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchPrompts

default SearchPromptsResponse searchPrompts(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InternalServiceException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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

This is a convenience which creates an instance of the SearchPromptsRequest.Builder avoiding the need to create one manually via SearchPromptsRequest.builder()

Parameters:

searchPromptsRequest - A Consumer that will call methods on SearchPromptsRequest.Builder to create a request.

Returns:

Result of the SearchPrompts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchPromptsPaginator

default SearchPromptsIterable searchPromptsPaginator(SearchPromptsRequest searchPromptsRequest)
                                              throws InvalidRequestException,
                                                     InvalidParameterException,
                                                     ResourceNotFoundException,
                                                     ThrottlingException,
                                                     InternalServiceException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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

This is a variant of searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchPromptsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation.

Parameters:

searchPromptsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchPromptsPaginator

default SearchPromptsIterable searchPromptsPaginator(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest)
                                              throws InvalidRequestException,
                                                     InvalidParameterException,
                                                     ResourceNotFoundException,
                                                     ThrottlingException,
                                                     InternalServiceException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     ConnectException

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

This is a variant of searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchPromptsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation.

This is a convenience which creates an instance of the SearchPromptsRequest.Builder avoiding the need to create one manually via SearchPromptsRequest.builder()

Parameters:

searchPromptsRequest - A Consumer that will call methods on SearchPromptsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQueues

default SearchQueuesResponse searchQueues(SearchQueuesRequest searchQueuesRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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

Parameters:

searchQueuesRequest -

Returns:

Result of the SearchQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQueues

default SearchQueuesResponse searchQueues(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

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

This is a convenience which creates an instance of the SearchQueuesRequest.Builder avoiding the need to create one manually via SearchQueuesRequest.builder()

Parameters:

searchQueuesRequest - A Consumer that will call methods on SearchQueuesRequest.Builder to create a request.

Returns:

Result of the SearchQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQueuesPaginator

default SearchQueuesIterable searchQueuesPaginator(SearchQueuesRequest searchQueuesRequest)
                                            throws InvalidRequestException,
                                                   InvalidParameterException,
                                                   ResourceNotFoundException,
                                                   ThrottlingException,
                                                   InternalServiceException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   ConnectException

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

This is a variant of searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation.

Parameters:

searchQueuesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQueuesPaginator

default SearchQueuesIterable searchQueuesPaginator(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest)
                                            throws InvalidRequestException,
                                                   InvalidParameterException,
                                                   ResourceNotFoundException,
                                                   ThrottlingException,
                                                   InternalServiceException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   ConnectException

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

This is a variant of searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation.

This is a convenience which creates an instance of the SearchQueuesRequest.Builder avoiding the need to create one manually via SearchQueuesRequest.builder()

Parameters:

searchQueuesRequest - A Consumer that will call methods on SearchQueuesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQuickConnects

default SearchQuickConnectsResponse searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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

Parameters:

searchQuickConnectsRequest -

Returns:

Result of the SearchQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQuickConnects

default SearchQuickConnectsResponse searchQuickConnects(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

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

This is a convenience which creates an instance of the SearchQuickConnectsRequest.Builder avoiding the need to create one manually via SearchQuickConnectsRequest.builder()

Parameters:

searchQuickConnectsRequest - A Consumer that will call methods on SearchQuickConnectsRequest.Builder to create a request.

Returns:

Result of the SearchQuickConnects operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQuickConnectsPaginator

default SearchQuickConnectsIterable searchQuickConnectsPaginator(SearchQuickConnectsRequest searchQuickConnectsRequest)
                                                          throws InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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

This is a variant of searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client
             .searchQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation.

Parameters:

searchQuickConnectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchQuickConnectsPaginator

default SearchQuickConnectsIterable searchQuickConnectsPaginator(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest)
                                                          throws InvalidRequestException,
                                                                 InvalidParameterException,
                                                                 ResourceNotFoundException,
                                                                 ThrottlingException,
                                                                 InternalServiceException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 ConnectException

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

This is a variant of searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client
             .searchQuickConnectsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation.

This is a convenience which creates an instance of the SearchQuickConnectsRequest.Builder avoiding the need to create one manually via SearchQuickConnectsRequest.builder()

Parameters:

searchQuickConnectsRequest - A Consumer that will call methods on SearchQuickConnectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchResourceTags

default SearchResourceTagsResponse searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      MaximumResultReturnedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

Parameters:

searchResourceTagsRequest -

Returns:

Result of the SearchResourceTags operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

MaximumResultReturnedException - Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchResourceTags

default SearchResourceTagsResponse searchResourceTags(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest)
                                               throws InvalidRequestException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InternalServiceException,
                                                      MaximumResultReturnedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

This is a convenience which creates an instance of the SearchResourceTagsRequest.Builder avoiding the need to create one manually via SearchResourceTagsRequest.builder()

Parameters:

searchResourceTagsRequest - A Consumer that will call methods on SearchResourceTagsRequest.Builder to create a request.

Returns:

Result of the SearchResourceTags operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

MaximumResultReturnedException - Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchResourceTagsPaginator

default SearchResourceTagsIterable searchResourceTagsPaginator(SearchResourceTagsRequest searchResourceTagsRequest)
                                                        throws InvalidRequestException,
                                                               InvalidParameterException,
                                                               ResourceNotFoundException,
                                                               ThrottlingException,
                                                               InternalServiceException,
                                                               MaximumResultReturnedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client
             .searchResourceTagsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation.

Parameters:

searchResourceTagsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

MaximumResultReturnedException - Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchResourceTagsPaginator

default SearchResourceTagsIterable searchResourceTagsPaginator(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest)
                                                        throws InvalidRequestException,
                                                               InvalidParameterException,
                                                               ResourceNotFoundException,
                                                               ThrottlingException,
                                                               InternalServiceException,
                                                               MaximumResultReturnedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client
             .searchResourceTagsPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation.

This is a convenience which creates an instance of the SearchResourceTagsRequest.Builder avoiding the need to create one manually via SearchResourceTagsRequest.builder()

Parameters:

searchResourceTagsRequest - A Consumer that will call methods on SearchResourceTagsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

MaximumResultReturnedException - Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchRoutingProfiles

default SearchRoutingProfilesResponse searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Parameters:

searchRoutingProfilesRequest -

Returns:

Result of the SearchRoutingProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchRoutingProfiles

default SearchRoutingProfilesResponse searchRoutingProfiles(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

This is a convenience which creates an instance of the SearchRoutingProfilesRequest.Builder avoiding the need to create one manually via SearchRoutingProfilesRequest.builder()

Parameters:

searchRoutingProfilesRequest - A Consumer that will call methods on SearchRoutingProfilesRequest.Builder to create a request.

Returns:

Result of the SearchRoutingProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchRoutingProfilesPaginator

default SearchRoutingProfilesIterable searchRoutingProfilesPaginator(SearchRoutingProfilesRequest searchRoutingProfilesRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     InternalServiceException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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

This is a variant of searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client
             .searchRoutingProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation.

Parameters:

searchRoutingProfilesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchRoutingProfilesPaginator

default SearchRoutingProfilesIterable searchRoutingProfilesPaginator(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest)
                                                              throws InvalidRequestException,
                                                                     InvalidParameterException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     InternalServiceException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConnectException

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

This is a variant of searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client
             .searchRoutingProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation.

This is a convenience which creates an instance of the SearchRoutingProfilesRequest.Builder avoiding the need to create one manually via SearchRoutingProfilesRequest.builder()

Parameters:

searchRoutingProfilesRequest - A Consumer that will call methods on SearchRoutingProfilesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchSecurityProfiles

default SearchSecurityProfilesResponse searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Parameters:

searchSecurityProfilesRequest -

Returns:

Result of the SearchSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchSecurityProfiles

default SearchSecurityProfilesResponse searchSecurityProfiles(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

This is a convenience which creates an instance of the SearchSecurityProfilesRequest.Builder avoiding the need to create one manually via SearchSecurityProfilesRequest.builder()

Parameters:

searchSecurityProfilesRequest - A Consumer that will call methods on SearchSecurityProfilesRequest.Builder to create a request.

Returns:

Result of the SearchSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchSecurityProfilesPaginator

default SearchSecurityProfilesIterable searchSecurityProfilesPaginator(SearchSecurityProfilesRequest searchSecurityProfilesRequest)
                                                                throws InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

This is a variant of searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client
             .searchSecurityProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation.

Parameters:

searchSecurityProfilesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchSecurityProfilesPaginator

default SearchSecurityProfilesIterable searchSecurityProfilesPaginator(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest)
                                                                throws InvalidRequestException,
                                                                       InvalidParameterException,
                                                                       ResourceNotFoundException,
                                                                       ThrottlingException,
                                                                       InternalServiceException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       ConnectException

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

This is a variant of searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client
             .searchSecurityProfilesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation.

This is a convenience which creates an instance of the SearchSecurityProfilesRequest.Builder avoiding the need to create one manually via SearchSecurityProfilesRequest.builder()

Parameters:

searchSecurityProfilesRequest - A Consumer that will call methods on SearchSecurityProfilesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchUsers

default SearchUsersResponse searchUsers(SearchUsersRequest searchUsersRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

AfterContactWorkTimeLimit is returned in milliseconds.

Parameters:

searchUsersRequest -

Returns:

Result of the SearchUsers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchUsers

default SearchUsersResponse searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

AfterContactWorkTimeLimit is returned in milliseconds.

This is a convenience which creates an instance of the SearchUsersRequest.Builder avoiding the need to create one manually via SearchUsersRequest.builder()

Parameters:

searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.Builder to create a request.

Returns:

Result of the SearchUsers operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchUsersPaginator

default SearchUsersIterable searchUsersPaginator(SearchUsersRequest searchUsersRequest)
                                          throws InvalidRequestException,
                                                 InvalidParameterException,
                                                 ResourceNotFoundException,
                                                 ThrottlingException,
                                                 InternalServiceException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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

AfterContactWorkTimeLimit is returned in milliseconds.

This is a variant of searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation.

Parameters:

searchUsersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchUsersPaginator

default SearchUsersIterable searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
                                          throws InvalidRequestException,
                                                 InvalidParameterException,
                                                 ResourceNotFoundException,
                                                 ThrottlingException,
                                                 InternalServiceException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 ConnectException

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

AfterContactWorkTimeLimit is returned in milliseconds.

This is a variant of searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation.

This is a convenience which creates an instance of the SearchUsersRequest.Builder avoiding the need to create one manually via SearchUsersRequest.builder()

Parameters:

searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchVocabularies

default SearchVocabulariesResponse searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest)
                                               throws InvalidRequestException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

Parameters:

searchVocabulariesRequest -

Returns:

Result of the SearchVocabularies operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchVocabularies

default SearchVocabulariesResponse searchVocabularies(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest)
                                               throws InvalidRequestException,
                                                      InternalServiceException,
                                                      ThrottlingException,
                                                      AccessDeniedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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

This is a convenience which creates an instance of the SearchVocabulariesRequest.Builder avoiding the need to create one manually via SearchVocabulariesRequest.builder()

Parameters:

searchVocabulariesRequest - A Consumer that will call methods on SearchVocabulariesRequest.Builder to create a request.

Returns:

Result of the SearchVocabularies operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchVocabulariesPaginator

default SearchVocabulariesIterable searchVocabulariesPaginator(SearchVocabulariesRequest searchVocabulariesRequest)
                                                        throws InvalidRequestException,
                                                               InternalServiceException,
                                                               ThrottlingException,
                                                               AccessDeniedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client
             .searchVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation.

Parameters:

searchVocabulariesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

searchVocabulariesPaginator

default SearchVocabulariesIterable searchVocabulariesPaginator(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest)
                                                        throws InvalidRequestException,
                                                               InternalServiceException,
                                                               ThrottlingException,
                                                               AccessDeniedException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               ConnectException

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

This is a variant of searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client
             .searchVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation.

This is a convenience which creates an instance of the SearchVocabulariesRequest.Builder avoiding the need to create one manually via SearchVocabulariesRequest.builder()

Parameters:

searchVocabulariesRequest - A Consumer that will call methods on SearchVocabulariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidRequestException - The request is not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startChatContact

default StartChatContactResponse startChatContact(StartChatContactRequest startChatContactRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  LimitExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

Parameters:

startChatContactRequest -

Returns:

Result of the StartChatContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startChatContact

default StartChatContactResponse startChatContact(Consumer<StartChatContactRequest.Builder> startChatContactRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  InternalServiceException,
                                                  LimitExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

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.

This is a convenience which creates an instance of the StartChatContactRequest.Builder avoiding the need to create one manually via StartChatContactRequest.builder()

Parameters:

startChatContactRequest - A Consumer that will call methods on StartChatContactRequest.Builder to create a request.

Returns:

Result of the StartChatContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactEvaluation

default StartContactEvaluationResponse startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest)
                                                       throws InternalServiceException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              ServiceQuotaExceededException,
                                                              ResourceConflictException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

startContactEvaluationRequest -

Returns:

Result of the StartContactEvaluation operation returned by the service.

Throws:

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactEvaluation

default StartContactEvaluationResponse startContactEvaluation(Consumer<StartContactEvaluationRequest.Builder> startContactEvaluationRequest)
                                                       throws InternalServiceException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              ServiceQuotaExceededException,
                                                              ResourceConflictException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the StartContactEvaluationRequest.Builder avoiding the need to create one manually via StartContactEvaluationRequest.builder()

Parameters:

startContactEvaluationRequest - A Consumer that will call methods on StartContactEvaluationRequest.Builder to create a request.

Returns:

Result of the StartContactEvaluation operation returned by the service.

Throws:

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactRecording

default StartContactRecordingResponse startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

Parameters:

startContactRecordingRequest -

Returns:

Result of the StartContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactRecording

default StartContactRecordingResponse startContactRecording(Consumer<StartContactRecordingRequest.Builder> startContactRecordingRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

This is a convenience which creates an instance of the StartContactRecordingRequest.Builder avoiding the need to create one manually via StartContactRecordingRequest.builder()

Parameters:

startContactRecordingRequest - A Consumer that will call methods on StartContactRecordingRequest.Builder to create a request.

Returns:

Result of the StartContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactStreaming

default StartContactStreamingResponse startContactStreaming(StartContactStreamingRequest startContactStreamingRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            LimitExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

Parameters:

startContactStreamingRequest -

Returns:

Result of the StartContactStreaming operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startContactStreaming

default StartContactStreamingResponse startContactStreaming(Consumer<StartContactStreamingRequest.Builder> startContactStreamingRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            InternalServiceException,
                                                            LimitExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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.

This is a convenience which creates an instance of the StartContactStreamingRequest.Builder avoiding the need to create one manually via StartContactStreamingRequest.builder()

Parameters:

startContactStreamingRequest - A Consumer that will call methods on StartContactStreamingRequest.Builder to create a request.

Returns:

Result of the StartContactStreaming operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startOutboundVoiceContact

default StartOutboundVoiceContactResponse startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
                                                             throws InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    InternalServiceException,
                                                                    LimitExceededException,
                                                                    DestinationNotAllowedException,
                                                                    OutboundContactNotPermittedException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

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.

Parameters:

startOutboundVoiceContactRequest -

Returns:

Result of the StartOutboundVoiceContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

DestinationNotAllowedException - Outbound calls to the destination number are not allowed.

OutboundContactNotPermittedException - The contact is not permitted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startOutboundVoiceContact

default StartOutboundVoiceContactResponse startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest)
                                                             throws InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    ResourceNotFoundException,
                                                                    InternalServiceException,
                                                                    LimitExceededException,
                                                                    DestinationNotAllowedException,
                                                                    OutboundContactNotPermittedException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

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.

This is a convenience which creates an instance of the StartOutboundVoiceContactRequest.Builder avoiding the need to create one manually via StartOutboundVoiceContactRequest.builder()

Parameters:

startOutboundVoiceContactRequest - A Consumer that will call methods on StartOutboundVoiceContactRequest.Builder to create a request.

Returns:

Result of the StartOutboundVoiceContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

LimitExceededException - The allowed limit for the resource has been exceeded.

DestinationNotAllowedException - Outbound calls to the destination number are not allowed.

OutboundContactNotPermittedException - The contact is not permitted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startTaskContact

default StartTaskContactResponse startTaskContact(StartTaskContactRequest startTaskContactRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  ServiceQuotaExceededException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

Initiates a flow to start a new task.

Parameters:

startTaskContactRequest -

Returns:

Result of the StartTaskContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startTaskContact

default StartTaskContactResponse startTaskContact(Consumer<StartTaskContactRequest.Builder> startTaskContactRequest)
                                           throws InvalidRequestException,
                                                  InvalidParameterException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  ServiceQuotaExceededException,
                                                  InternalServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ConnectException

Initiates a flow to start a new task.

This is a convenience which creates an instance of the StartTaskContactRequest.Builder avoiding the need to create one manually via StartTaskContactRequest.builder()

Parameters:

startTaskContactRequest - A Consumer that will call methods on StartTaskContactRequest.Builder to create a request.

Returns:

Result of the StartTaskContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContact

default StopContactResponse stopContact(StopContactRequest stopContactRequest)
                                 throws InvalidRequestException,
                                        ContactNotFoundException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

• DISCONNECT

• TRANSFER

• QUEUE_TRANSFER

Parameters:

stopContactRequest -

Returns:

Result of the StopContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ContactNotFoundException - The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat, Task, or Voice Callback.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContact

default StopContactResponse stopContact(Consumer<StopContactRequest.Builder> stopContactRequest)
                                 throws InvalidRequestException,
                                        ContactNotFoundException,
                                        InvalidParameterException,
                                        ResourceNotFoundException,
                                        InternalServiceException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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

• DISCONNECT

• TRANSFER

• QUEUE_TRANSFER

This is a convenience which creates an instance of the StopContactRequest.Builder avoiding the need to create one manually via StopContactRequest.builder()

Parameters:

stopContactRequest - A Consumer that will call methods on StopContactRequest.Builder to create a request.

Returns:

Result of the StopContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ContactNotFoundException - The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat, Task, or Voice Callback.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContactRecording

default StopContactRecordingResponse stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)
                                                   throws InvalidRequestException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

stopContactRecordingRequest -

Returns:

Result of the StopContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContactRecording

default StopContactRecordingResponse stopContactRecording(Consumer<StopContactRecordingRequest.Builder> stopContactRecordingRequest)
                                                   throws InvalidRequestException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

This is a convenience which creates an instance of the StopContactRecordingRequest.Builder avoiding the need to create one manually via StopContactRecordingRequest.builder()

Parameters:

stopContactRecordingRequest - A Consumer that will call methods on StopContactRecordingRequest.Builder to create a request.

Returns:

Result of the StopContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContactStreaming

default StopContactStreamingResponse stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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

Parameters:

stopContactStreamingRequest -

Returns:

Result of the StopContactStreaming operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopContactStreaming

default StopContactStreamingResponse stopContactStreaming(Consumer<StopContactStreamingRequest.Builder> stopContactStreamingRequest)
                                                   throws InvalidRequestException,
                                                          InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          InternalServiceException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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

This is a convenience which creates an instance of the StopContactStreamingRequest.Builder avoiding the need to create one manually via StopContactStreamingRequest.builder()

Parameters:

stopContactStreamingRequest - A Consumer that will call methods on StopContactStreamingRequest.Builder to create a request.

Returns:

Result of the StopContactStreaming operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

submitContactEvaluation

default SubmitContactEvaluationResponse submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

submitContactEvaluationRequest -

Returns:

Result of the SubmitContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

submitContactEvaluation

default SubmitContactEvaluationResponse submitContactEvaluation(Consumer<SubmitContactEvaluationRequest.Builder> submitContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the SubmitContactEvaluationRequest.Builder avoiding the need to create one manually via SubmitContactEvaluationRequest.builder()

Parameters:

submitContactEvaluationRequest - A Consumer that will call methods on SubmitContactEvaluationRequest.Builder to create a request.

Returns:

Result of the SubmitContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

suspendContactRecording

default SuspendContactRecordingResponse suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
                                                         throws InvalidRequestException,
                                                                ResourceNotFoundException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

suspendContactRecordingRequest -

Returns:

Result of the SuspendContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

suspendContactRecording

default SuspendContactRecordingResponse suspendContactRecording(Consumer<SuspendContactRecordingRequest.Builder> suspendContactRecordingRequest)
                                                         throws InvalidRequestException,
                                                                ResourceNotFoundException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the SuspendContactRecordingRequest.Builder avoiding the need to create one manually via SuspendContactRecordingRequest.builder()

Parameters:

suspendContactRecordingRequest - A Consumer that will call methods on SuspendContactRecordingRequest.Builder to create a request.

Returns:

Result of the SuspendContactRecording operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        InternalServiceException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InvalidRequestException,
                                        InvalidParameterException,
                                        InternalServiceException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ConnectException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

transferContact

default TransferContactResponse transferContact(TransferContactRequest transferContactRequest)
                                         throws InvalidRequestException,
                                                IdempotencyException,
                                                AccessDeniedException,
                                                ResourceNotFoundException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

transferContactRequest -

Returns:

Result of the TransferContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

transferContact

default TransferContactResponse transferContact(Consumer<TransferContactRequest.Builder> transferContactRequest)
                                         throws InvalidRequestException,
                                                IdempotencyException,
                                                AccessDeniedException,
                                                ResourceNotFoundException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

This is a convenience which creates an instance of the TransferContactRequest.Builder avoiding the need to create one manually via TransferContactRequest.builder()

Parameters:

transferContactRequest - A Consumer that will call methods on TransferContactRequest.Builder to create a request.

Returns:

Result of the TransferContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ServiceQuotaExceededException - The service quota has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

Removes the specified tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateAgentStatus

default UpdateAgentStatusResponse updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    ResourceNotFoundException,
                                                    LimitExceededException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Updates agent status.

Parameters:

updateAgentStatusRequest -

Returns:

Result of the UpdateAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateAgentStatus

default UpdateAgentStatusResponse updateAgentStatus(Consumer<UpdateAgentStatusRequest.Builder> updateAgentStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    DuplicateResourceException,
                                                    ResourceNotFoundException,
                                                    LimitExceededException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Updates agent status.

This is a convenience which creates an instance of the UpdateAgentStatusRequest.Builder avoiding the need to create one manually via UpdateAgentStatusRequest.builder()

Parameters:

updateAgentStatusRequest - A Consumer that will call methods on UpdateAgentStatusRequest.Builder to create a request.

Returns:

Result of the UpdateAgentStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The allowed limit for the resource has been exceeded.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContact

default UpdateContactResponse updateContact(UpdateContactRequest updateContactRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            InternalServiceException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

Parameters:

updateContactRequest -

Returns:

Result of the UpdateContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContact

default UpdateContactResponse updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)
                                     throws InvalidRequestException,
                                            InvalidParameterException,
                                            ResourceNotFoundException,
                                            InternalServiceException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ConnectException

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.

This is a convenience which creates an instance of the UpdateContactRequest.Builder avoiding the need to create one manually via UpdateContactRequest.builder()

Parameters:

updateContactRequest - A Consumer that will call methods on UpdateContactRequest.Builder to create a request.

Returns:

Result of the UpdateContact operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactAttributes

default UpdateContactAttributesResponse updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

updateContactAttributesRequest -

Returns:

Result of the UpdateContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactAttributes

default UpdateContactAttributesResponse updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest)
                                                         throws InvalidRequestException,
                                                                InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                InternalServiceException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the UpdateContactAttributesRequest.Builder avoiding the need to create one manually via UpdateContactAttributesRequest.builder()

Parameters:

updateContactAttributesRequest - A Consumer that will call methods on UpdateContactAttributesRequest.Builder to create a request.

Returns:

Result of the UpdateContactAttributes operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactEvaluation

default UpdateContactEvaluationResponse updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

Parameters:

updateContactEvaluationRequest -

Returns:

Result of the UpdateContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactEvaluation

default UpdateContactEvaluationResponse updateContactEvaluation(Consumer<UpdateContactEvaluationRequest.Builder> updateContactEvaluationRequest)
                                                         throws InvalidParameterException,
                                                                ResourceNotFoundException,
                                                                ThrottlingException,
                                                                InternalServiceException,
                                                                ResourceConflictException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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.

This is a convenience which creates an instance of the UpdateContactEvaluationRequest.Builder avoiding the need to create one manually via UpdateContactEvaluationRequest.builder()

Parameters:

updateContactEvaluationRequest - A Consumer that will call methods on UpdateContactEvaluationRequest.Builder to create a request.

Returns:

Result of the UpdateContactEvaluation operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowContent

default UpdateContactFlowContentResponse updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidContactFlowException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Updates the specified flow.

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

Parameters:

updateContactFlowContentRequest -

Returns:

Result of the UpdateContactFlowContent operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowContent

default UpdateContactFlowContentResponse updateContactFlowContent(Consumer<UpdateContactFlowContentRequest.Builder> updateContactFlowContentRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidContactFlowException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Updates the specified flow.

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

This is a convenience which creates an instance of the UpdateContactFlowContentRequest.Builder avoiding the need to create one manually via UpdateContactFlowContentRequest.builder()

Parameters:

updateContactFlowContentRequest - A Consumer that will call methods on UpdateContactFlowContentRequest.Builder to create a request.

Returns:

Result of the UpdateContactFlowContent operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidContactFlowException - The flow is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowMetadata

default UpdateContactFlowMetadataResponse updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)
                                                             throws InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    DuplicateResourceException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Updates metadata about specified flow.

Parameters:

updateContactFlowMetadataRequest -

Returns:

Result of the UpdateContactFlowMetadata operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowMetadata

default UpdateContactFlowMetadataResponse updateContactFlowMetadata(Consumer<UpdateContactFlowMetadataRequest.Builder> updateContactFlowMetadataRequest)
                                                             throws InvalidRequestException,
                                                                    InvalidParameterException,
                                                                    DuplicateResourceException,
                                                                    ResourceNotFoundException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Updates metadata about specified flow.

This is a convenience which creates an instance of the UpdateContactFlowMetadataRequest.Builder avoiding the need to create one manually via UpdateContactFlowMetadataRequest.builder()

Parameters:

updateContactFlowMetadataRequest - A Consumer that will call methods on UpdateContactFlowMetadataRequest.Builder to create a request.

Returns:

Result of the UpdateContactFlowMetadata operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowModuleContent

default UpdateContactFlowModuleContentResponse updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)
                                                                       throws AccessDeniedException,
                                                                              InvalidRequestException,
                                                                              InvalidContactFlowModuleException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

Updates specified flow module for the specified Amazon Connect instance.

Parameters:

updateContactFlowModuleContentRequest -

Returns:

Result of the UpdateContactFlowModuleContent operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowModuleContent

default UpdateContactFlowModuleContentResponse updateContactFlowModuleContent(Consumer<UpdateContactFlowModuleContentRequest.Builder> updateContactFlowModuleContentRequest)
                                                                       throws AccessDeniedException,
                                                                              InvalidRequestException,
                                                                              InvalidContactFlowModuleException,
                                                                              ResourceNotFoundException,
                                                                              ThrottlingException,
                                                                              InternalServiceException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConnectException

Updates specified flow module for the specified Amazon Connect instance.

This is a convenience which creates an instance of the UpdateContactFlowModuleContentRequest.Builder avoiding the need to create one manually via UpdateContactFlowModuleContentRequest.builder()

Parameters:

updateContactFlowModuleContentRequest - A Consumer that will call methods on UpdateContactFlowModuleContentRequest.Builder to create a request.

Returns:

Result of the UpdateContactFlowModuleContent operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidContactFlowModuleException - The problems with the module. Please fix before trying again.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowModuleMetadata

default UpdateContactFlowModuleMetadataResponse updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)
                                                                         throws AccessDeniedException,
                                                                                InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                DuplicateResourceException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

Updates metadata about specified flow module.

Parameters:

updateContactFlowModuleMetadataRequest -

Returns:

Result of the UpdateContactFlowModuleMetadata operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowModuleMetadata

default UpdateContactFlowModuleMetadataResponse updateContactFlowModuleMetadata(Consumer<UpdateContactFlowModuleMetadataRequest.Builder> updateContactFlowModuleMetadataRequest)
                                                                         throws AccessDeniedException,
                                                                                InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                DuplicateResourceException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

Updates metadata about specified flow module.

This is a convenience which creates an instance of the UpdateContactFlowModuleMetadataRequest.Builder avoiding the need to create one manually via UpdateContactFlowModuleMetadataRequest.builder()

Parameters:

updateContactFlowModuleMetadataRequest - A Consumer that will call methods on UpdateContactFlowModuleMetadataRequest.Builder to create a request.

Returns:

Result of the UpdateContactFlowModuleMetadata operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient permissions to perform this action.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowName

default UpdateContactFlowNameResponse updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            DuplicateResourceException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

The name of the flow.

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

Parameters:

updateContactFlowNameRequest -

Returns:

Result of the UpdateContactFlowName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactFlowName

default UpdateContactFlowNameResponse updateContactFlowName(Consumer<UpdateContactFlowNameRequest.Builder> updateContactFlowNameRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            DuplicateResourceException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

The name of the flow.

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

This is a convenience which creates an instance of the UpdateContactFlowNameRequest.Builder avoiding the need to create one manually via UpdateContactFlowNameRequest.builder()

Parameters:

updateContactFlowNameRequest - A Consumer that will call methods on UpdateContactFlowNameRequest.Builder to create a request.

Returns:

Result of the UpdateContactFlowName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactSchedule

default UpdateContactScheduleResponse updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            LimitExceededException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Parameters:

updateContactScheduleRequest -

Returns:

Result of the UpdateContactSchedule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

LimitExceededException - The allowed limit for the resource has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateContactSchedule

default UpdateContactScheduleResponse updateContactSchedule(Consumer<UpdateContactScheduleRequest.Builder> updateContactScheduleRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            LimitExceededException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

This is a convenience which creates an instance of the UpdateContactScheduleRequest.Builder avoiding the need to create one manually via UpdateContactScheduleRequest.builder()

Parameters:

updateContactScheduleRequest - A Consumer that will call methods on UpdateContactScheduleRequest.Builder to create a request.

Returns:

Result of the UpdateContactSchedule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

LimitExceededException - The allowed limit for the resource has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEvaluationForm

default UpdateEvaluationFormResponse updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest)
                                                   throws InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          ServiceQuotaExceededException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

Parameters:

updateEvaluationFormRequest -

Returns:

Result of the UpdateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEvaluationForm

default UpdateEvaluationFormResponse updateEvaluationForm(Consumer<UpdateEvaluationFormRequest.Builder> updateEvaluationFormRequest)
                                                   throws InvalidParameterException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InternalServiceException,
                                                          ServiceQuotaExceededException,
                                                          ResourceConflictException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConnectException

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.

This is a convenience which creates an instance of the UpdateEvaluationFormRequest.Builder avoiding the need to create one manually via UpdateEvaluationFormRequest.builder()

Parameters:

updateEvaluationFormRequest - A Consumer that will call methods on UpdateEvaluationFormRequest.Builder to create a request.

Returns:

Result of the UpdateEvaluationForm operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ServiceQuotaExceededException - The service quota has been exceeded.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateHoursOfOperation

default UpdateHoursOfOperationResponse updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)
                                                       throws DuplicateResourceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Updates the hours of operation.

Parameters:

updateHoursOfOperationRequest -

Returns:

Result of the UpdateHoursOfOperation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateHoursOfOperation

default UpdateHoursOfOperationResponse updateHoursOfOperation(Consumer<UpdateHoursOfOperationRequest.Builder> updateHoursOfOperationRequest)
                                                       throws DuplicateResourceException,
                                                              InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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

Updates the hours of operation.

This is a convenience which creates an instance of the UpdateHoursOfOperationRequest.Builder avoiding the need to create one manually via UpdateHoursOfOperationRequest.builder()

Parameters:

updateHoursOfOperationRequest - A Consumer that will call methods on UpdateHoursOfOperationRequest.Builder to create a request.

Returns:

Result of the UpdateHoursOfOperation operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateInstanceAttribute

default UpdateInstanceAttributeResponse updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
                                                         throws ResourceNotFoundException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Updates the value for the specified attribute type.

Parameters:

updateInstanceAttributeRequest -

Returns:

Result of the UpdateInstanceAttribute operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateInstanceAttribute

default UpdateInstanceAttributeResponse updateInstanceAttribute(Consumer<UpdateInstanceAttributeRequest.Builder> updateInstanceAttributeRequest)
                                                         throws ResourceNotFoundException,
                                                                InternalServiceException,
                                                                InvalidRequestException,
                                                                InvalidParameterException,
                                                                ThrottlingException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ConnectException

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

Updates the value for the specified attribute type.

This is a convenience which creates an instance of the UpdateInstanceAttributeRequest.Builder avoiding the need to create one manually via UpdateInstanceAttributeRequest.builder()

Parameters:

updateInstanceAttributeRequest - A Consumer that will call methods on UpdateInstanceAttributeRequest.Builder to create a request.

Returns:

Result of the UpdateInstanceAttribute operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateInstanceStorageConfig

default UpdateInstanceStorageConfigResponse updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
                                                                 throws ResourceNotFoundException,
                                                                        InternalServiceException,
                                                                        InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

Parameters:

updateInstanceStorageConfigRequest -

Returns:

Result of the UpdateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateInstanceStorageConfig

default UpdateInstanceStorageConfigResponse updateInstanceStorageConfig(Consumer<UpdateInstanceStorageConfigRequest.Builder> updateInstanceStorageConfigRequest)
                                                                 throws ResourceNotFoundException,
                                                                        InternalServiceException,
                                                                        InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ThrottlingException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

This is a convenience which creates an instance of the UpdateInstanceStorageConfigRequest.Builder avoiding the need to create one manually via UpdateInstanceStorageConfigRequest.builder()

Parameters:

updateInstanceStorageConfigRequest - A Consumer that will call methods on UpdateInstanceStorageConfigRequest.Builder to create a request.

Returns:

Result of the UpdateInstanceStorageConfig operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ThrottlingException - The throttling limit has been exceeded.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateParticipantRoleConfig

default UpdateParticipantRoleConfigResponse updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        AccessDeniedException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

Parameters:

updateParticipantRoleConfigRequest -

Returns:

Result of the UpdateParticipantRoleConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateParticipantRoleConfig

default UpdateParticipantRoleConfigResponse updateParticipantRoleConfig(Consumer<UpdateParticipantRoleConfigRequest.Builder> updateParticipantRoleConfigRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        AccessDeniedException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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.

This is a convenience which creates an instance of the UpdateParticipantRoleConfigRequest.Builder avoiding the need to create one manually via UpdateParticipantRoleConfigRequest.builder()

Parameters:

updateParticipantRoleConfigRequest - A Consumer that will call methods on UpdateParticipantRoleConfigRequest.Builder to create a request.

Returns:

Result of the UpdateParticipantRoleConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePhoneNumber

default UpdatePhoneNumberResponse updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
                                             throws InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    ResourceInUseException,
                                                    IdempotencyException,
                                                    AccessDeniedException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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.

Parameters:

updatePhoneNumberRequest -

Returns:

Result of the UpdatePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceInUseException - That resource is already in use. Please try another.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePhoneNumber

default UpdatePhoneNumberResponse updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest)
                                             throws InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    ResourceInUseException,
                                                    IdempotencyException,
                                                    AccessDeniedException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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.

This is a convenience which creates an instance of the UpdatePhoneNumberRequest.Builder avoiding the need to create one manually via UpdatePhoneNumberRequest.builder()

Parameters:

updatePhoneNumberRequest - A Consumer that will call methods on UpdatePhoneNumberRequest.Builder to create a request.

Returns:

Result of the UpdatePhoneNumber operation returned by the service.

Throws:

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

ResourceInUseException - That resource is already in use. Please try another.

IdempotencyException - An entity with the same name already exists.

AccessDeniedException - You do not have sufficient permissions to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePrompt

default UpdatePromptResponse updatePrompt(UpdatePromptRequest updatePromptRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Updates a prompt.

Parameters:

updatePromptRequest -

Returns:

Result of the UpdatePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updatePrompt

default UpdatePromptResponse updatePrompt(Consumer<UpdatePromptRequest.Builder> updatePromptRequest)
                                   throws InvalidRequestException,
                                          InvalidParameterException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalServiceException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ConnectException

Updates a prompt.

This is a convenience which creates an instance of the UpdatePromptRequest.Builder avoiding the need to create one manually via UpdatePromptRequest.builder()

Parameters:

updatePromptRequest - A Consumer that will call methods on UpdatePromptRequest.Builder to create a request.

Returns:

Result of the UpdatePrompt operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueHoursOfOperation

default UpdateQueueHoursOfOperationResponse updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

Updates the hours of operation for the specified queue.

Parameters:

updateQueueHoursOfOperationRequest -

Returns:

Result of the UpdateQueueHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueHoursOfOperation

default UpdateQueueHoursOfOperationResponse updateQueueHoursOfOperation(Consumer<UpdateQueueHoursOfOperationRequest.Builder> updateQueueHoursOfOperationRequest)
                                                                 throws InvalidRequestException,
                                                                        InvalidParameterException,
                                                                        ResourceNotFoundException,
                                                                        ThrottlingException,
                                                                        InternalServiceException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConnectException

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

Updates the hours of operation for the specified queue.

This is a convenience which creates an instance of the UpdateQueueHoursOfOperationRequest.Builder avoiding the need to create one manually via UpdateQueueHoursOfOperationRequest.builder()

Parameters:

updateQueueHoursOfOperationRequest - A Consumer that will call methods on UpdateQueueHoursOfOperationRequest.Builder to create a request.

Returns:

Result of the UpdateQueueHoursOfOperation operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueMaxContacts

default UpdateQueueMaxContactsResponse updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

updateQueueMaxContactsRequest -

Returns:

Result of the UpdateQueueMaxContacts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueMaxContacts

default UpdateQueueMaxContactsResponse updateQueueMaxContacts(Consumer<UpdateQueueMaxContactsRequest.Builder> updateQueueMaxContactsRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the UpdateQueueMaxContactsRequest.Builder avoiding the need to create one manually via UpdateQueueMaxContactsRequest.builder()

Parameters:

updateQueueMaxContactsRequest - A Consumer that will call methods on UpdateQueueMaxContactsRequest.Builder to create a request.

Returns:

Result of the UpdateQueueMaxContacts operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueName

default UpdateQueueNameResponse updateQueueName(UpdateQueueNameRequest updateQueueNameRequest)
                                         throws DuplicateResourceException,
                                                InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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.

Parameters:

updateQueueNameRequest -

Returns:

Result of the UpdateQueueName operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueName

default UpdateQueueNameResponse updateQueueName(Consumer<UpdateQueueNameRequest.Builder> updateQueueNameRequest)
                                         throws DuplicateResourceException,
                                                InvalidRequestException,
                                                InvalidParameterException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InternalServiceException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConnectException

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 is a convenience which creates an instance of the UpdateQueueNameRequest.Builder avoiding the need to create one manually via UpdateQueueNameRequest.builder()

Parameters:

updateQueueNameRequest - A Consumer that will call methods on UpdateQueueNameRequest.Builder to create a request.

Returns:

Result of the UpdateQueueName operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueOutboundCallerConfig

default UpdateQueueOutboundCallerConfigResponse updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)
                                                                         throws InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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.

Parameters:

updateQueueOutboundCallerConfigRequest -

Returns:

Result of the UpdateQueueOutboundCallerConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueOutboundCallerConfig

default UpdateQueueOutboundCallerConfigResponse updateQueueOutboundCallerConfig(Consumer<UpdateQueueOutboundCallerConfigRequest.Builder> updateQueueOutboundCallerConfigRequest)
                                                                         throws InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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 is a convenience which creates an instance of the UpdateQueueOutboundCallerConfigRequest.Builder avoiding the need to create one manually via UpdateQueueOutboundCallerConfigRequest.builder()

Parameters:

updateQueueOutboundCallerConfigRequest - A Consumer that will call methods on UpdateQueueOutboundCallerConfigRequest.Builder to create a request.

Returns:

Result of the UpdateQueueOutboundCallerConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueStatus

default UpdateQueueStatusResponse updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Updates the status of the queue.

Parameters:

updateQueueStatusRequest -

Returns:

Result of the UpdateQueueStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQueueStatus

default UpdateQueueStatusResponse updateQueueStatus(Consumer<UpdateQueueStatusRequest.Builder> updateQueueStatusRequest)
                                             throws InvalidRequestException,
                                                    InvalidParameterException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InternalServiceException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConnectException

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

Updates the status of the queue.

This is a convenience which creates an instance of the UpdateQueueStatusRequest.Builder avoiding the need to create one manually via UpdateQueueStatusRequest.builder()

Parameters:

updateQueueStatusRequest - A Consumer that will call methods on UpdateQueueStatusRequest.Builder to create a request.

Returns:

Result of the UpdateQueueStatus operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQuickConnectConfig

default UpdateQuickConnectConfigResponse updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Updates the configuration settings for the specified quick connect.

Parameters:

updateQuickConnectConfigRequest -

Returns:

Result of the UpdateQuickConnectConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQuickConnectConfig

default UpdateQuickConnectConfigResponse updateQuickConnectConfig(Consumer<UpdateQuickConnectConfigRequest.Builder> updateQuickConnectConfigRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Updates the configuration settings for the specified quick connect.

This is a convenience which creates an instance of the UpdateQuickConnectConfigRequest.Builder avoiding the need to create one manually via UpdateQuickConnectConfigRequest.builder()

Parameters:

updateQuickConnectConfigRequest - A Consumer that will call methods on UpdateQuickConnectConfigRequest.Builder to create a request.

Returns:

Result of the UpdateQuickConnectConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQuickConnectName

default UpdateQuickConnectNameResponse updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

updateQuickConnectNameRequest -

Returns:

Result of the UpdateQuickConnectName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQuickConnectName

default UpdateQuickConnectNameResponse updateQuickConnectName(Consumer<UpdateQuickConnectNameRequest.Builder> updateQuickConnectNameRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the UpdateQuickConnectNameRequest.Builder avoiding the need to create one manually via UpdateQuickConnectNameRequest.builder()

Parameters:

updateQuickConnectNameRequest - A Consumer that will call methods on UpdateQuickConnectNameRequest.Builder to create a request.

Returns:

Result of the UpdateQuickConnectName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileAgentAvailabilityTimer

default UpdateRoutingProfileAgentAvailabilityTimerResponse updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)
                                                                                               throws InvalidRequestException,
                                                                                                      InvalidParameterException,
                                                                                                      ResourceNotFoundException,
                                                                                                      ThrottlingException,
                                                                                                      InternalServiceException,
                                                                                                      AwsServiceException,
                                                                                                      SdkClientException,
                                                                                                      ConnectException

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

Parameters:

updateRoutingProfileAgentAvailabilityTimerRequest -

Returns:

Result of the UpdateRoutingProfileAgentAvailabilityTimer operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileAgentAvailabilityTimer

default UpdateRoutingProfileAgentAvailabilityTimerResponse updateRoutingProfileAgentAvailabilityTimer(Consumer<UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder> updateRoutingProfileAgentAvailabilityTimerRequest)
                                                                                               throws InvalidRequestException,
                                                                                                      InvalidParameterException,
                                                                                                      ResourceNotFoundException,
                                                                                                      ThrottlingException,
                                                                                                      InternalServiceException,
                                                                                                      AwsServiceException,
                                                                                                      SdkClientException,
                                                                                                      ConnectException

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

This is a convenience which creates an instance of the UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder avoiding the need to create one manually via UpdateRoutingProfileAgentAvailabilityTimerRequest.builder()

Parameters:

updateRoutingProfileAgentAvailabilityTimerRequest - A Consumer that will call methods on UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder to create a request.

Returns:

Result of the UpdateRoutingProfileAgentAvailabilityTimer operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileConcurrency

default UpdateRoutingProfileConcurrencyResponse updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
                                                                         throws InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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

Parameters:

updateRoutingProfileConcurrencyRequest -

Returns:

Result of the UpdateRoutingProfileConcurrency operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileConcurrency

default UpdateRoutingProfileConcurrencyResponse updateRoutingProfileConcurrency(Consumer<UpdateRoutingProfileConcurrencyRequest.Builder> updateRoutingProfileConcurrencyRequest)
                                                                         throws InvalidRequestException,
                                                                                InvalidParameterException,
                                                                                ResourceNotFoundException,
                                                                                ThrottlingException,
                                                                                InternalServiceException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConnectException

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

This is a convenience which creates an instance of the UpdateRoutingProfileConcurrencyRequest.Builder avoiding the need to create one manually via UpdateRoutingProfileConcurrencyRequest.builder()

Parameters:

updateRoutingProfileConcurrencyRequest - A Consumer that will call methods on UpdateRoutingProfileConcurrencyRequest.Builder to create a request.

Returns:

Result of the UpdateRoutingProfileConcurrency operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileDefaultOutboundQueue

default UpdateRoutingProfileDefaultOutboundQueueResponse updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
                                                                                           throws InvalidRequestException,
                                                                                                  InvalidParameterException,
                                                                                                  ResourceNotFoundException,
                                                                                                  ThrottlingException,
                                                                                                  InternalServiceException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConnectException

Updates the default outbound queue of a routing profile.

Parameters:

updateRoutingProfileDefaultOutboundQueueRequest -

Returns:

Result of the UpdateRoutingProfileDefaultOutboundQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileDefaultOutboundQueue

default UpdateRoutingProfileDefaultOutboundQueueResponse updateRoutingProfileDefaultOutboundQueue(Consumer<UpdateRoutingProfileDefaultOutboundQueueRequest.Builder> updateRoutingProfileDefaultOutboundQueueRequest)
                                                                                           throws InvalidRequestException,
                                                                                                  InvalidParameterException,
                                                                                                  ResourceNotFoundException,
                                                                                                  ThrottlingException,
                                                                                                  InternalServiceException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConnectException

Updates the default outbound queue of a routing profile.

This is a convenience which creates an instance of the UpdateRoutingProfileDefaultOutboundQueueRequest.Builder avoiding the need to create one manually via UpdateRoutingProfileDefaultOutboundQueueRequest.builder()

Parameters:

updateRoutingProfileDefaultOutboundQueueRequest - A Consumer that will call methods on UpdateRoutingProfileDefaultOutboundQueueRequest.Builder to create a request.

Returns:

Result of the UpdateRoutingProfileDefaultOutboundQueue operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileName

default UpdateRoutingProfileNameResponse updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
                                                           throws DuplicateResourceException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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.

Parameters:

updateRoutingProfileNameRequest -

Returns:

Result of the UpdateRoutingProfileName operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileName

default UpdateRoutingProfileNameResponse updateRoutingProfileName(Consumer<UpdateRoutingProfileNameRequest.Builder> updateRoutingProfileNameRequest)
                                                           throws DuplicateResourceException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

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.

This is a convenience which creates an instance of the UpdateRoutingProfileNameRequest.Builder avoiding the need to create one manually via UpdateRoutingProfileNameRequest.builder()

Parameters:

updateRoutingProfileNameRequest - A Consumer that will call methods on UpdateRoutingProfileNameRequest.Builder to create a request.

Returns:

Result of the UpdateRoutingProfileName operation returned by the service.

Throws:

DuplicateResourceException - A resource with the specified name already exists.

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileQueues

default UpdateRoutingProfileQueuesResponse updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

Parameters:

updateRoutingProfileQueuesRequest -

Returns:

Result of the UpdateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoutingProfileQueues

default UpdateRoutingProfileQueuesResponse updateRoutingProfileQueues(Consumer<UpdateRoutingProfileQueuesRequest.Builder> updateRoutingProfileQueuesRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

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

This is a convenience which creates an instance of the UpdateRoutingProfileQueuesRequest.Builder avoiding the need to create one manually via UpdateRoutingProfileQueuesRequest.builder()

Parameters:

updateRoutingProfileQueuesRequest - A Consumer that will call methods on UpdateRoutingProfileQueuesRequest.Builder to create a request.

Returns:

Result of the UpdateRoutingProfileQueues operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRule

default UpdateRuleResponse updateRule(UpdateRuleRequest updateRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      ResourceConflictException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Updates a rule for the specified Amazon Connect instance.

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

Parameters:

updateRuleRequest -

Returns:

Result of the UpdateRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRule

default UpdateRuleResponse updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)
                               throws InvalidRequestException,
                                      ResourceNotFoundException,
                                      InternalServiceException,
                                      ThrottlingException,
                                      AccessDeniedException,
                                      ResourceConflictException,
                                      AwsServiceException,
                                      SdkClientException,
                                      ConnectException

Updates a rule for the specified Amazon Connect instance.

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

This is a convenience which creates an instance of the UpdateRuleRequest.Builder avoiding the need to create one manually via UpdateRuleRequest.builder()

Parameters:

updateRuleRequest - A Consumer that will call methods on UpdateRuleRequest.Builder to create a request.

Returns:

Result of the UpdateRule operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource was not found.

InternalServiceException - Request processing failed because of an error or failure with the service.

ThrottlingException - The throttling limit has been exceeded.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceConflictException - A resource already has that name.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecurityProfile

default UpdateSecurityProfileResponse updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Updates a security profile.

Parameters:

updateSecurityProfileRequest -

Returns:

Result of the UpdateSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecurityProfile

default UpdateSecurityProfileResponse updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

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

Updates a security profile.

This is a convenience which creates an instance of the UpdateSecurityProfileRequest.Builder avoiding the need to create one manually via UpdateSecurityProfileRequest.builder()

Parameters:

updateSecurityProfileRequest - A Consumer that will call methods on UpdateSecurityProfileRequest.Builder to create a request.

Returns:

Result of the UpdateSecurityProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateTaskTemplate

default UpdateTaskTemplateResponse updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest)
                                               throws PropertyValidationException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      ServiceQuotaExceededException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

Parameters:

updateTaskTemplateRequest -

Returns:

Result of the UpdateTaskTemplate operation returned by the service.

Throws:

PropertyValidationException - The property is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateTaskTemplate

default UpdateTaskTemplateResponse updateTaskTemplate(Consumer<UpdateTaskTemplateRequest.Builder> updateTaskTemplateRequest)
                                               throws PropertyValidationException,
                                                      InvalidParameterException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      ServiceQuotaExceededException,
                                                      InternalServiceException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConnectException

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.

This is a convenience which creates an instance of the UpdateTaskTemplateRequest.Builder avoiding the need to create one manually via UpdateTaskTemplateRequest.builder()

Parameters:

updateTaskTemplateRequest - A Consumer that will call methods on UpdateTaskTemplateRequest.Builder to create a request.

Returns:

Result of the UpdateTaskTemplate operation returned by the service.

Throws:

PropertyValidationException - The property is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

ServiceQuotaExceededException - The service quota has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateTrafficDistribution

default UpdateTrafficDistributionResponse updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)
                                                             throws InvalidRequestException,
                                                                    AccessDeniedException,
                                                                    ResourceNotFoundException,
                                                                    ResourceConflictException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Updates the traffic distribution for a given traffic distribution group.

You can change the SignInConfig only for a default TrafficDistributionGroup. If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

Parameters:

updateTrafficDistributionRequest -

Returns:

Result of the UpdateTrafficDistribution operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateTrafficDistribution

default UpdateTrafficDistributionResponse updateTrafficDistribution(Consumer<UpdateTrafficDistributionRequest.Builder> updateTrafficDistributionRequest)
                                                             throws InvalidRequestException,
                                                                    AccessDeniedException,
                                                                    ResourceNotFoundException,
                                                                    ResourceConflictException,
                                                                    ThrottlingException,
                                                                    InternalServiceException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConnectException

Updates the traffic distribution for a given traffic distribution group.

You can change the SignInConfig only for a default TrafficDistributionGroup. If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

This is a convenience which creates an instance of the UpdateTrafficDistributionRequest.Builder avoiding the need to create one manually via UpdateTrafficDistributionRequest.builder()

Parameters:

updateTrafficDistributionRequest - A Consumer that will call methods on UpdateTrafficDistributionRequest.Builder to create a request.

Returns:

Result of the UpdateTrafficDistribution operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

AccessDeniedException - You do not have sufficient permissions to perform this action.

ResourceNotFoundException - The specified resource was not found.

ResourceConflictException - A resource already has that name.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchy

default UpdateUserHierarchyResponse updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Assigns the specified hierarchy group to the specified user.

Parameters:

updateUserHierarchyRequest -

Returns:

Result of the UpdateUserHierarchy operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchy

default UpdateUserHierarchyResponse updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest)
                                                 throws InvalidRequestException,
                                                        InvalidParameterException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        InternalServiceException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ConnectException

Assigns the specified hierarchy group to the specified user.

This is a convenience which creates an instance of the UpdateUserHierarchyRequest.Builder avoiding the need to create one manually via UpdateUserHierarchyRequest.builder()

Parameters:

updateUserHierarchyRequest - A Consumer that will call methods on UpdateUserHierarchyRequest.Builder to create a request.

Returns:

Result of the UpdateUserHierarchy operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchyGroupName

default UpdateUserHierarchyGroupNameResponse updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
                                                                   throws InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          DuplicateResourceException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InternalServiceException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

Updates the name of the user hierarchy group.

Parameters:

updateUserHierarchyGroupNameRequest -

Returns:

Result of the UpdateUserHierarchyGroupName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchyGroupName

default UpdateUserHierarchyGroupNameResponse updateUserHierarchyGroupName(Consumer<UpdateUserHierarchyGroupNameRequest.Builder> updateUserHierarchyGroupNameRequest)
                                                                   throws InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          DuplicateResourceException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InternalServiceException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

Updates the name of the user hierarchy group.

This is a convenience which creates an instance of the UpdateUserHierarchyGroupNameRequest.Builder avoiding the need to create one manually via UpdateUserHierarchyGroupNameRequest.builder()

Parameters:

updateUserHierarchyGroupNameRequest - A Consumer that will call methods on UpdateUserHierarchyGroupNameRequest.Builder to create a request.

Returns:

Result of the UpdateUserHierarchyGroupName operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

DuplicateResourceException - A resource with the specified name already exists.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchyStructure

default UpdateUserHierarchyStructureResponse updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
                                                                   throws InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          ResourceNotFoundException,
                                                                          ResourceInUseException,
                                                                          ThrottlingException,
                                                                          InternalServiceException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

Parameters:

updateUserHierarchyStructureRequest -

Returns:

Result of the UpdateUserHierarchyStructure operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserHierarchyStructure

default UpdateUserHierarchyStructureResponse updateUserHierarchyStructure(Consumer<UpdateUserHierarchyStructureRequest.Builder> updateUserHierarchyStructureRequest)
                                                                   throws InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          ResourceNotFoundException,
                                                                          ResourceInUseException,
                                                                          ThrottlingException,
                                                                          InternalServiceException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConnectException

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

This is a convenience which creates an instance of the UpdateUserHierarchyStructureRequest.Builder avoiding the need to create one manually via UpdateUserHierarchyStructureRequest.builder()

Parameters:

updateUserHierarchyStructureRequest - A Consumer that will call methods on UpdateUserHierarchyStructureRequest.Builder to create a request.

Returns:

Result of the UpdateUserHierarchyStructure operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - That resource is already in use. Please try another.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserIdentityInfo

default UpdateUserIdentityInfoResponse updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

Parameters:

updateUserIdentityInfoRequest -

Returns:

Result of the UpdateUserIdentityInfo operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserIdentityInfo

default UpdateUserIdentityInfoResponse updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest)
                                                       throws InvalidRequestException,
                                                              InvalidParameterException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              InternalServiceException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConnectException

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.

This is a convenience which creates an instance of the UpdateUserIdentityInfoRequest.Builder avoiding the need to create one manually via UpdateUserIdentityInfoRequest.builder()

Parameters:

updateUserIdentityInfoRequest - A Consumer that will call methods on UpdateUserIdentityInfoRequest.Builder to create a request.

Returns:

Result of the UpdateUserIdentityInfo operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserPhoneConfig

default UpdateUserPhoneConfigResponse updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

Updates the phone configuration settings for the specified user.

Parameters:

updateUserPhoneConfigRequest -

Returns:

Result of the UpdateUserPhoneConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserPhoneConfig

default UpdateUserPhoneConfigResponse updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest)
                                                     throws InvalidRequestException,
                                                            InvalidParameterException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            InternalServiceException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConnectException

Updates the phone configuration settings for the specified user.

This is a convenience which creates an instance of the UpdateUserPhoneConfigRequest.Builder avoiding the need to create one manually via UpdateUserPhoneConfigRequest.builder()

Parameters:

updateUserPhoneConfigRequest - A Consumer that will call methods on UpdateUserPhoneConfigRequest.Builder to create a request.

Returns:

Result of the UpdateUserPhoneConfig operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserRoutingProfile

default UpdateUserRoutingProfileResponse updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Assigns the specified routing profile to the specified user.

Parameters:

updateUserRoutingProfileRequest -

Returns:

Result of the UpdateUserRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserRoutingProfile

default UpdateUserRoutingProfileResponse updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  ResourceNotFoundException,
                                                                  ThrottlingException,
                                                                  InternalServiceException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConnectException

Assigns the specified routing profile to the specified user.

This is a convenience which creates an instance of the UpdateUserRoutingProfileRequest.Builder avoiding the need to create one manually via UpdateUserRoutingProfileRequest.builder()

Parameters:

updateUserRoutingProfileRequest - A Consumer that will call methods on UpdateUserRoutingProfileRequest.Builder to create a request.

Returns:

Result of the UpdateUserRoutingProfile operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserSecurityProfiles

default UpdateUserSecurityProfilesResponse updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

Assigns the specified security profiles to the specified user.

Parameters:

updateUserSecurityProfilesRequest -

Returns:

Result of the UpdateUserSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateUserSecurityProfiles

default UpdateUserSecurityProfilesResponse updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest)
                                                               throws InvalidRequestException,
                                                                      InvalidParameterException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServiceException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConnectException

Assigns the specified security profiles to the specified user.

This is a convenience which creates an instance of the UpdateUserSecurityProfilesRequest.Builder avoiding the need to create one manually via UpdateUserSecurityProfilesRequest.builder()

Parameters:

updateUserSecurityProfilesRequest - A Consumer that will call methods on UpdateUserSecurityProfilesRequest.Builder to create a request.

Returns:

Result of the UpdateUserSecurityProfiles operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the specified parameters are not valid.

ResourceNotFoundException - The specified resource was not found.

ThrottlingException - The throttling limit has been exceeded.

InternalServiceException - Request processing failed because of an error or failure with the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static ConnectClient create()

Create a ConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ConnectClientBuilder builder()

Create a builder that can be used to configure and create a ConnectClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ConnectServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient