Interface ConnectClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault ActivateEvaluationFormResponse
activateEvaluationForm
(Consumer<ActivateEvaluationFormRequest.Builder> activateEvaluationFormRequest) Activates an evaluation form in the specified Amazon Connect instance.default ActivateEvaluationFormResponse
activateEvaluationForm
(ActivateEvaluationFormRequest activateEvaluationFormRequest) Activates an evaluation form in the specified Amazon Connect instance.associateAnalyticsDataSet
(Consumer<AssociateAnalyticsDataSetRequest.Builder> associateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.associateAnalyticsDataSet
(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest) 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 AssociateApprovedOriginResponse
associateApprovedOrigin
(AssociateApprovedOriginRequest associateApprovedOriginRequest) 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 AssociateBotResponse
associateBot
(AssociateBotRequest associateBotRequest) This API is in preview release for Amazon Connect and is subject to change.associateDefaultVocabulary
(Consumer<AssociateDefaultVocabularyRequest.Builder> associateDefaultVocabularyRequest) Associates an existing vocabulary as the default.associateDefaultVocabulary
(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest) Associates an existing vocabulary as the default.default AssociateFlowResponse
associateFlow
(Consumer<AssociateFlowRequest.Builder> associateFlowRequest) Associates a connect resource to a flow.default AssociateFlowResponse
associateFlow
(AssociateFlowRequest associateFlowRequest) Associates a connect resource to a flow.associateInstanceStorageConfig
(Consumer<AssociateInstanceStorageConfigRequest.Builder> associateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.associateInstanceStorageConfig
(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) 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 AssociateLambdaFunctionResponse
associateLambdaFunction
(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) 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 AssociateLexBotResponse
associateLexBot
(AssociateLexBotRequest associateLexBotRequest) This API is in preview release for Amazon Connect and is subject to change.associatePhoneNumberContactFlow
(Consumer<AssociatePhoneNumberContactFlowRequest.Builder> associatePhoneNumberContactFlowRequest) Associates a flow with a phone number claimed to your Amazon Connect instance.associatePhoneNumberContactFlow
(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest) Associates a flow with a phone number claimed to your Amazon Connect instance.associateQueueQuickConnects
(Consumer<AssociateQueueQuickConnectsRequest.Builder> associateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.associateQueueQuickConnects
(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.associateRoutingProfileQueues
(Consumer<AssociateRoutingProfileQueuesRequest.Builder> associateRoutingProfileQueuesRequest) Associates a set of queues with a routing profile.associateRoutingProfileQueues
(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) Associates a set of queues with a routing profile.default AssociateSecurityKeyResponse
associateSecurityKey
(Consumer<AssociateSecurityKeyRequest.Builder> associateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.default AssociateSecurityKeyResponse
associateSecurityKey
(AssociateSecurityKeyRequest associateSecurityKeyRequest) This API is in preview release for Amazon Connect and is subject to change.associateTrafficDistributionGroupUser
(Consumer<AssociateTrafficDistributionGroupUserRequest.Builder> associateTrafficDistributionGroupUserRequest) Associates an agent with a traffic distribution group.associateTrafficDistributionGroupUser
(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest) Associates an agent with a traffic distribution group.associateUserProficiencies
(Consumer<AssociateUserProficienciesRequest.Builder> associateUserProficienciesRequest) >Associates a set of proficiencies with a user.associateUserProficiencies
(AssociateUserProficienciesRequest associateUserProficienciesRequest) >Associates a set of proficiencies with a user.batchAssociateAnalyticsDataSet
(Consumer<BatchAssociateAnalyticsDataSetRequest.Builder> batchAssociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.batchAssociateAnalyticsDataSet
(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.batchDisassociateAnalyticsDataSet
(Consumer<BatchDisassociateAnalyticsDataSetRequest.Builder> batchDisassociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.batchDisassociateAnalyticsDataSet
(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.batchGetAttachedFileMetadata
(Consumer<BatchGetAttachedFileMetadataRequest.Builder> batchGetAttachedFileMetadataRequest) Allows you to retrieve metadata about multiple attached files on an associated resource.batchGetAttachedFileMetadata
(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest) Allows you to retrieve metadata about multiple attached files on an associated resource.default BatchGetFlowAssociationResponse
batchGetFlowAssociation
(Consumer<BatchGetFlowAssociationRequest.Builder> batchGetFlowAssociationRequest) Retrieve the flow associations for the given resources.default BatchGetFlowAssociationResponse
batchGetFlowAssociation
(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest) Retrieve the flow associations for the given resources.default BatchPutContactResponse
batchPutContact
(Consumer<BatchPutContactRequest.Builder> batchPutContactRequest) default BatchPutContactResponse
batchPutContact
(BatchPutContactRequest batchPutContactRequest) static ConnectClientBuilder
builder()
Create a builder that can be used to configure and create aConnectClient
.default ClaimPhoneNumberResponse
claimPhoneNumber
(Consumer<ClaimPhoneNumberRequest.Builder> claimPhoneNumberRequest) Claims an available phone number to your Amazon Connect instance or traffic distribution group.default ClaimPhoneNumberResponse
claimPhoneNumber
(ClaimPhoneNumberRequest claimPhoneNumberRequest) Claims an available phone number to your Amazon Connect instance or traffic distribution group.completeAttachedFileUpload
(Consumer<CompleteAttachedFileUploadRequest.Builder> completeAttachedFileUploadRequest) Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.completeAttachedFileUpload
(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest) Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.static ConnectClient
create()
Create aConnectClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createIntegrationAssociation
(Consumer<CreateIntegrationAssociationRequest.Builder> createIntegrationAssociationRequest) Creates an Amazon Web Services resource association with an Amazon Connect instance.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.createPersistentContactAssociation
(Consumer<CreatePersistentContactAssociationRequest.Builder> createPersistentContactAssociationRequest) Enables rehydration of chats for the lifespan of a contact.createPersistentContactAssociation
(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest) Enables rehydration of chats for the lifespan of a contact.createPredefinedAttribute
(Consumer<CreatePredefinedAttributeRequest.Builder> createPredefinedAttributeRequest) Creates a new predefined attribute for the specified Amazon Connect instance.createPredefinedAttribute
(CreatePredefinedAttributeRequest createPredefinedAttributeRequest) Creates a new predefined attribute for the specified Amazon Connect instance.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) Creates a security profile.default CreateSecurityProfileResponse
createSecurityProfile
(CreateSecurityProfileRequest createSecurityProfileRequest) Creates a security profile.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.createTrafficDistributionGroup
(Consumer<CreateTrafficDistributionGroupRequest.Builder> createTrafficDistributionGroupRequest) Creates a traffic distribution group given an Amazon Connect instance that has been replicated.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 CreateViewResponse
createView
(Consumer<CreateViewRequest.Builder> createViewRequest) Creates a new view with the possible status ofSAVED
orPUBLISHED
.default CreateViewResponse
createView
(CreateViewRequest createViewRequest) Creates a new view with the possible status ofSAVED
orPUBLISHED
.default CreateViewVersionResponse
createViewVersion
(Consumer<CreateViewVersionRequest.Builder> createViewVersionRequest) Publishes a new version of the view identifier.default CreateViewVersionResponse
createViewVersion
(CreateViewVersionRequest createViewVersionRequest) Publishes a new version of the view identifier.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 DeleteAttachedFileResponse
deleteAttachedFile
(Consumer<DeleteAttachedFileRequest.Builder> deleteAttachedFileRequest) Deletes an attached file along with the underlying S3 Object.default DeleteAttachedFileResponse
deleteAttachedFile
(DeleteAttachedFileRequest deleteAttachedFileRequest) Deletes an attached file along with the underlying S3 Object.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.deleteIntegrationAssociation
(Consumer<DeleteIntegrationAssociationRequest.Builder> deleteIntegrationAssociationRequest) Deletes an Amazon Web Services resource association from an Amazon Connect instance.deleteIntegrationAssociation
(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) Deletes an Amazon Web Services resource association from an Amazon Connect instance.deletePredefinedAttribute
(Consumer<DeletePredefinedAttributeRequest.Builder> deletePredefinedAttributeRequest) Deletes a predefined attribute from the specified Amazon Connect instance.deletePredefinedAttribute
(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest) Deletes a predefined attribute from the specified 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) Deletes a security profile.default DeleteSecurityProfileResponse
deleteSecurityProfile
(DeleteSecurityProfileRequest deleteSecurityProfileRequest) Deletes a security profile.default DeleteTaskTemplateResponse
deleteTaskTemplate
(Consumer<DeleteTaskTemplateRequest.Builder> deleteTaskTemplateRequest) Deletes the task template.default DeleteTaskTemplateResponse
deleteTaskTemplate
(DeleteTaskTemplateRequest deleteTaskTemplateRequest) Deletes the task template.deleteTrafficDistributionGroup
(Consumer<DeleteTrafficDistributionGroupRequest.Builder> deleteTrafficDistributionGroupRequest) Deletes a traffic distribution group.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 DeleteViewResponse
deleteView
(Consumer<DeleteViewRequest.Builder> deleteViewRequest) Deletes the view entirely.default DeleteViewResponse
deleteView
(DeleteViewRequest deleteViewRequest) Deletes the view entirely.default DeleteViewVersionResponse
deleteViewVersion
(Consumer<DeleteViewVersionRequest.Builder> deleteViewVersionRequest) Deletes the particular version specified inViewVersion
identifier.default DeleteViewVersionResponse
deleteViewVersion
(DeleteViewVersionRequest deleteViewVersionRequest) Deletes the particular version specified inViewVersion
identifier.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.describeContactEvaluation
(Consumer<DescribeContactEvaluationRequest.Builder> describeContactEvaluationRequest) Describes a contact evaluation in the specified Amazon Connect instance.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.describeContactFlowModule
(Consumer<DescribeContactFlowModuleRequest.Builder> describeContactFlowModuleRequest) Describes the specified flow module.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.describeInstanceAttribute
(Consumer<DescribeInstanceAttributeRequest.Builder> describeInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.describeInstanceAttribute
(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) This API is in preview release for Amazon Connect and is subject to change.describeInstanceStorageConfig
(Consumer<DescribeInstanceStorageConfigRequest.Builder> describeInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.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.describePredefinedAttribute
(Consumer<DescribePredefinedAttributeRequest.Builder> describePredefinedAttributeRequest) Describes a predefined attribute for the specified Amazon Connect instance.describePredefinedAttribute
(DescribePredefinedAttributeRequest describePredefinedAttributeRequest) Describes a predefined attribute for the specified Amazon Connect instance.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) Gets basic information about the security profle.default DescribeSecurityProfileResponse
describeSecurityProfile
(DescribeSecurityProfileRequest describeSecurityProfileRequest) Gets basic information about the security profle.describeTrafficDistributionGroup
(Consumer<DescribeTrafficDistributionGroupRequest.Builder> describeTrafficDistributionGroupRequest) Gets details and status of a traffic distribution group.describeTrafficDistributionGroup
(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest) Gets details and status of a traffic distribution group.default DescribeUserResponse
describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Describes the specified user.default DescribeUserResponse
describeUser
(DescribeUserRequest describeUserRequest) Describes the specified user.describeUserHierarchyGroup
(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest) Describes the specified hierarchy group.describeUserHierarchyGroup
(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) Describes the specified hierarchy group.describeUserHierarchyStructure
(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest) Describes the hierarchy structure of the specified Amazon Connect instance.describeUserHierarchyStructure
(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) Describes the hierarchy structure of the specified Amazon Connect instance.default DescribeViewResponse
describeView
(Consumer<DescribeViewRequest.Builder> describeViewRequest) Retrieves the view for the specified Amazon Connect instance and view identifier.default DescribeViewResponse
describeView
(DescribeViewRequest describeViewRequest) Retrieves the view for the specified Amazon Connect instance and view identifier.default DescribeVocabularyResponse
describeVocabulary
(Consumer<DescribeVocabularyRequest.Builder> describeVocabularyRequest) Describes the specified vocabulary.default DescribeVocabularyResponse
describeVocabulary
(DescribeVocabularyRequest describeVocabularyRequest) Describes the specified vocabulary.disassociateAnalyticsDataSet
(Consumer<DisassociateAnalyticsDataSetRequest.Builder> disassociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateAnalyticsDataSet
(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateApprovedOrigin
(Consumer<DisassociateApprovedOriginRequest.Builder> disassociateApprovedOriginRequest) This API is in preview release for Amazon Connect and is subject to change.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 DisassociateFlowResponse
disassociateFlow
(Consumer<DisassociateFlowRequest.Builder> disassociateFlowRequest) Disassociates a connect resource from a flow.default DisassociateFlowResponse
disassociateFlow
(DisassociateFlowRequest disassociateFlowRequest) Disassociates a connect resource from a flow.disassociateInstanceStorageConfig
(Consumer<DisassociateInstanceStorageConfigRequest.Builder> disassociateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateInstanceStorageConfig
(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateLambdaFunction
(Consumer<DisassociateLambdaFunctionRequest.Builder> disassociateLambdaFunctionRequest) This API is in preview release for Amazon Connect and is subject to change.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.disassociatePhoneNumberContactFlow
(Consumer<DisassociatePhoneNumberContactFlowRequest.Builder> disassociatePhoneNumberContactFlowRequest) Removes the flow association from a phone number claimed to your Amazon Connect instance.disassociatePhoneNumberContactFlow
(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest) Removes the flow association from a phone number claimed to your Amazon Connect instance.disassociateQueueQuickConnects
(Consumer<DisassociateQueueQuickConnectsRequest.Builder> disassociateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateQueueQuickConnects
(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest) This API is in preview release for Amazon Connect and is subject to change.disassociateRoutingProfileQueues
(Consumer<DisassociateRoutingProfileQueuesRequest.Builder> disassociateRoutingProfileQueuesRequest) Disassociates a set of queues from a routing profile.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.disassociateTrafficDistributionGroupUser
(Consumer<DisassociateTrafficDistributionGroupUserRequest.Builder> disassociateTrafficDistributionGroupUserRequest) Disassociates an agent from a traffic distribution group.disassociateTrafficDistributionGroupUser
(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest) Disassociates an agent from a traffic distribution group.disassociateUserProficiencies
(Consumer<DisassociateUserProficienciesRequest.Builder> disassociateUserProficienciesRequest) Disassociates a set of proficiencies from a user.disassociateUserProficiencies
(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest) Disassociates a set of proficiencies from a user.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 GetAttachedFileResponse
getAttachedFile
(Consumer<GetAttachedFileRequest.Builder> getAttachedFileRequest) Provides a pre-signed URL for download of an approved attached file.default GetAttachedFileResponse
getAttachedFile
(GetAttachedFileRequest getAttachedFileRequest) Provides a pre-signed URL for download of an approved attached file.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) This is a variant ofgetCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.default GetCurrentMetricDataIterable
getCurrentMetricDataPaginator
(GetCurrentMetricDataRequest getCurrentMetricDataRequest) This is a variant ofgetCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.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) This is a variant ofgetCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest)
operation.default GetCurrentUserDataIterable
getCurrentUserDataPaginator
(GetCurrentUserDataRequest getCurrentUserDataRequest) This is a variant ofgetCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest)
operation.default GetFederationTokenResponse
getFederationToken
(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest) Supports SAML sign-in for Amazon Connect.default GetFederationTokenResponse
getFederationToken
(GetFederationTokenRequest getFederationTokenRequest) Supports SAML sign-in for Amazon Connect.default GetFlowAssociationResponse
getFlowAssociation
(Consumer<GetFlowAssociationRequest.Builder> getFlowAssociationRequest) Retrieves the flow associated for a given resource.default GetFlowAssociationResponse
getFlowAssociation
(GetFlowAssociationRequest getFlowAssociationRequest) Retrieves the flow associated for a given resource.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) This is a variant ofgetMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation.default GetMetricDataIterable
getMetricDataPaginator
(GetMetricDataRequest getMetricDataRequest) This is a variant ofgetMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation.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) This is a variant ofgetMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request)
operation.default GetMetricDataV2Iterable
getMetricDataV2Paginator
(GetMetricDataV2Request getMetricDataV2Request) This is a variant ofgetMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request)
operation.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 ImportPhoneNumberResponse
importPhoneNumber
(Consumer<ImportPhoneNumberRequest.Builder> importPhoneNumberRequest) Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.default ImportPhoneNumberResponse
importPhoneNumber
(ImportPhoneNumberRequest importPhoneNumberRequest) Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.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 is a variant oflistAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest)
operation.default ListAgentStatusesIterable
listAgentStatusesPaginator
(ListAgentStatusesRequest listAgentStatusesRequest) This is a variant oflistAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest)
operation.listAnalyticsDataAssociations
(Consumer<ListAnalyticsDataAssociationsRequest.Builder> listAnalyticsDataAssociationsRequest) This API is in preview release for Amazon Connect and is subject to change.listAnalyticsDataAssociations
(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest) 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 is a variant oflistApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest)
operation.default ListApprovedOriginsIterable
listApprovedOriginsPaginator
(ListApprovedOriginsRequest listApprovedOriginsRequest) This is a variant oflistApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest)
operation.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 is a variant oflistBots(software.amazon.awssdk.services.connect.model.ListBotsRequest)
operation.default ListBotsIterable
listBotsPaginator
(ListBotsRequest listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.connect.model.ListBotsRequest)
operation.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) This is a variant oflistContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest)
operation.default ListContactEvaluationsIterable
listContactEvaluationsPaginator
(ListContactEvaluationsRequest listContactEvaluationsRequest) This is a variant oflistContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest)
operation.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) This is a variant oflistContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest)
operation.default ListContactFlowModulesIterable
listContactFlowModulesPaginator
(ListContactFlowModulesRequest listContactFlowModulesRequest) This is a variant oflistContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest)
operation.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) This is a variant oflistContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest)
operation.default ListContactFlowsIterable
listContactFlowsPaginator
(ListContactFlowsRequest listContactFlowsRequest) This is a variant oflistContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest)
operation.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 is a variant oflistContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest)
operation.default ListContactReferencesIterable
listContactReferencesPaginator
(ListContactReferencesRequest listContactReferencesRequest) This is a variant oflistContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest)
operation.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) This is a variant oflistDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest)
operation.default ListDefaultVocabulariesIterable
listDefaultVocabulariesPaginator
(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) This is a variant oflistDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest)
operation.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) This is a variant oflistEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest)
operation.default ListEvaluationFormsIterable
listEvaluationFormsPaginator
(ListEvaluationFormsRequest listEvaluationFormsRequest) This is a variant oflistEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest)
operation.listEvaluationFormVersions
(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.listEvaluationFormVersions
(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) Lists versions of an evaluation form in the specified Amazon Connect instance.listEvaluationFormVersionsPaginator
(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest) This is a variant oflistEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest)
operation.listEvaluationFormVersionsPaginator
(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) This is a variant oflistEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest)
operation.default ListFlowAssociationsResponse
listFlowAssociations
(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest) List the flow association based on the filters.default ListFlowAssociationsResponse
listFlowAssociations
(ListFlowAssociationsRequest listFlowAssociationsRequest) List the flow association based on the filters.default ListFlowAssociationsIterable
listFlowAssociationsPaginator
(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest) This is a variant oflistFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
operation.default ListFlowAssociationsIterable
listFlowAssociationsPaginator
(ListFlowAssociationsRequest listFlowAssociationsRequest) This is a variant oflistFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
operation.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) This is a variant oflistHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest)
operation.default ListHoursOfOperationsIterable
listHoursOfOperationsPaginator
(ListHoursOfOperationsRequest listHoursOfOperationsRequest) This is a variant oflistHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest)
operation.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 is a variant oflistInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest)
operation.default ListInstanceAttributesIterable
listInstanceAttributesPaginator
(ListInstanceAttributesRequest listInstanceAttributesRequest) This is a variant oflistInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest)
operation.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 is a variant oflistInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest)
operation.default ListInstancesIterable
listInstancesPaginator
(ListInstancesRequest listInstancesRequest) This is a variant oflistInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest)
operation.listInstanceStorageConfigs
(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.listInstanceStorageConfigs
(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) This API is in preview release for Amazon Connect and is subject to change.listInstanceStorageConfigsPaginator
(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest) This is a variant oflistInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest)
operation.listInstanceStorageConfigsPaginator
(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) This is a variant oflistInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest)
operation.listIntegrationAssociations
(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.listIntegrationAssociations
(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.listIntegrationAssociationsPaginator
(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest) This is a variant oflistIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest)
operation.listIntegrationAssociationsPaginator
(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) This is a variant oflistIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest)
operation.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 is a variant oflistLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest)
operation.default ListLambdaFunctionsIterable
listLambdaFunctionsPaginator
(ListLambdaFunctionsRequest listLambdaFunctionsRequest) This is a variant oflistLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest)
operation.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 is a variant oflistLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest)
operation.default ListLexBotsIterable
listLexBotsPaginator
(ListLexBotsRequest listLexBotsRequest) This is a variant oflistLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest)
operation.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) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest)
operation.default ListPhoneNumbersIterable
listPhoneNumbersPaginator
(ListPhoneNumbersRequest listPhoneNumbersRequest) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest)
operation.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) This is a variant oflistPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request)
operation.default ListPhoneNumbersV2Iterable
listPhoneNumbersV2Paginator
(ListPhoneNumbersV2Request listPhoneNumbersV2Request) This is a variant oflistPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request)
operation.default ListPredefinedAttributesResponse
listPredefinedAttributes
(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest) Lists predefined attributes for the specified Amazon Connect instance.default ListPredefinedAttributesResponse
listPredefinedAttributes
(ListPredefinedAttributesRequest listPredefinedAttributesRequest) Lists predefined attributes for the specified Amazon Connect instance.default ListPredefinedAttributesIterable
listPredefinedAttributesPaginator
(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest) This is a variant oflistPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
operation.default ListPredefinedAttributesIterable
listPredefinedAttributesPaginator
(ListPredefinedAttributesRequest listPredefinedAttributesRequest) This is a variant oflistPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
operation.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) This is a variant oflistPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest)
operation.default ListPromptsIterable
listPromptsPaginator
(ListPromptsRequest listPromptsRequest) This is a variant oflistPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest)
operation.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 is a variant oflistQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest)
operation.default ListQueueQuickConnectsIterable
listQueueQuickConnectsPaginator
(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) This is a variant oflistQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest)
operation.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) This is a variant oflistQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest)
operation.default ListQueuesIterable
listQueuesPaginator
(ListQueuesRequest listQueuesRequest) This is a variant oflistQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest)
operation.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) This is a variant oflistQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest)
operation.default ListQuickConnectsIterable
listQuickConnectsPaginator
(ListQuickConnectsRequest listQuickConnectsRequest) This is a variant oflistQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest)
operation.listRealtimeContactAnalysisSegmentsV2
(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request) Provides a list of analysis segments for a real-time analysis session.listRealtimeContactAnalysisSegmentsV2
(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request) Provides a list of analysis segments for a real-time analysis session.listRealtimeContactAnalysisSegmentsV2Paginator
(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request) listRealtimeContactAnalysisSegmentsV2Paginator
(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request) 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) This is a variant oflistRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest)
operation.default ListRoutingProfileQueuesIterable
listRoutingProfileQueuesPaginator
(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) This is a variant oflistRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest)
operation.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) This is a variant oflistRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest)
operation.default ListRoutingProfilesIterable
listRoutingProfilesPaginator
(ListRoutingProfilesRequest listRoutingProfilesRequest) This is a variant oflistRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest)
operation.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) This is a variant oflistRules(software.amazon.awssdk.services.connect.model.ListRulesRequest)
operation.default ListRulesIterable
listRulesPaginator
(ListRulesRequest listRulesRequest) This is a variant oflistRules(software.amazon.awssdk.services.connect.model.ListRulesRequest)
operation.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 is a variant oflistSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest)
operation.default ListSecurityKeysIterable
listSecurityKeysPaginator
(ListSecurityKeysRequest listSecurityKeysRequest) This is a variant oflistSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest)
operation.listSecurityProfileApplications
(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest) Returns a list of third-party applications in a specific security profile.listSecurityProfileApplications
(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest) Returns a list of third-party applications in a specific security profile.listSecurityProfileApplicationsPaginator
(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest) This is a variant oflistSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
operation.listSecurityProfileApplicationsPaginator
(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest) This is a variant oflistSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
operation.listSecurityProfilePermissions
(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) Lists the permissions granted to a security profile.listSecurityProfilePermissions
(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) Lists the permissions granted to a security profile.listSecurityProfilePermissionsPaginator
(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) This is a variant oflistSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest)
operation.listSecurityProfilePermissionsPaginator
(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) This is a variant oflistSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest)
operation.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) This is a variant oflistSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest)
operation.default ListSecurityProfilesIterable
listSecurityProfilesPaginator
(ListSecurityProfilesRequest listSecurityProfilesRequest) This is a variant oflistSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest)
operation.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) This is a variant oflistTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest)
operation.default ListTaskTemplatesIterable
listTaskTemplatesPaginator
(ListTaskTemplatesRequest listTaskTemplatesRequest) This is a variant oflistTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest)
operation.listTrafficDistributionGroups
(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest) Lists traffic distribution groups.listTrafficDistributionGroups
(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) Lists traffic distribution groups.listTrafficDistributionGroupsPaginator
(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest) This is a variant oflistTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest)
operation.listTrafficDistributionGroupsPaginator
(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) This is a variant oflistTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest)
operation.listTrafficDistributionGroupUsers
(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.listTrafficDistributionGroupUsers
(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) Lists traffic distribution group users.listTrafficDistributionGroupUsersPaginator
(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest) This is a variant oflistTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest)
operation.listTrafficDistributionGroupUsersPaginator
(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) This is a variant oflistTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest)
operation.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) This is a variant oflistUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest)
operation.default ListUseCasesIterable
listUseCasesPaginator
(ListUseCasesRequest listUseCasesRequest) This is a variant oflistUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest)
operation.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) This is a variant oflistUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest)
operation.default ListUserHierarchyGroupsIterable
listUserHierarchyGroupsPaginator
(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) This is a variant oflistUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest)
operation.default ListUserProficienciesResponse
listUserProficiencies
(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest) Lists proficiencies associated with a user.default ListUserProficienciesResponse
listUserProficiencies
(ListUserProficienciesRequest listUserProficienciesRequest) Lists proficiencies associated with a user.default ListUserProficienciesIterable
listUserProficienciesPaginator
(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest) This is a variant oflistUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
operation.default ListUserProficienciesIterable
listUserProficienciesPaginator
(ListUserProficienciesRequest listUserProficienciesRequest) This is a variant oflistUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
operation.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) This is a variant oflistUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest)
operation.default ListUsersIterable
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest)
operation.default ListViewsResponse
listViews
(Consumer<ListViewsRequest.Builder> listViewsRequest) Returns views in the given instance.default ListViewsResponse
listViews
(ListViewsRequest listViewsRequest) Returns views in the given instance.default ListViewsIterable
listViewsPaginator
(Consumer<ListViewsRequest.Builder> listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
operation.default ListViewsIterable
listViewsPaginator
(ListViewsRequest listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
operation.default ListViewVersionsResponse
listViewVersions
(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest) Returns all the available versions for the specified Amazon Connect instance and view identifier.default ListViewVersionsResponse
listViewVersions
(ListViewVersionsRequest listViewVersionsRequest) Returns all the available versions for the specified Amazon Connect instance and view identifier.default ListViewVersionsIterable
listViewVersionsPaginator
(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest) This is a variant oflistViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
operation.default ListViewVersionsIterable
listViewVersionsPaginator
(ListViewVersionsRequest listViewVersionsRequest) This is a variant oflistViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
operation.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 PauseContactResponse
pauseContact
(Consumer<PauseContactRequest.Builder> pauseContactRequest) Allows pausing an ongoing task contact.default PauseContactResponse
pauseContact
(PauseContactRequest pauseContactRequest) Allows pausing an ongoing task 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 and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.default ReplicateInstanceResponse
replicateInstance
(ReplicateInstanceRequest replicateInstanceRequest) Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.default ResumeContactResponse
resumeContact
(Consumer<ResumeContactRequest.Builder> resumeContactRequest) Allows resuming a task contact in a paused state.default ResumeContactResponse
resumeContact
(ResumeContactRequest resumeContactRequest) Allows resuming a task contact in a paused state.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 whatever recording is selected in the flow configuration: call, screen, or both.default ResumeContactRecordingResponse
resumeContactRecording
(ResumeContactRecordingRequest resumeContactRecordingRequest) When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both.searchAvailablePhoneNumbers
(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.searchAvailablePhoneNumbers
(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.searchAvailablePhoneNumbersPaginator
(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest)
operation.searchAvailablePhoneNumbersPaginator
(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest)
operation.default SearchContactFlowModulesResponse
searchContactFlowModules
(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest) Searches the flow modules in an Amazon Connect instance, with optional filtering.default SearchContactFlowModulesResponse
searchContactFlowModules
(SearchContactFlowModulesRequest searchContactFlowModulesRequest) Searches the flow modules in an Amazon Connect instance, with optional filtering.default SearchContactFlowModulesIterable
searchContactFlowModulesPaginator
(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest) This is a variant ofsearchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
operation.default SearchContactFlowModulesIterable
searchContactFlowModulesPaginator
(SearchContactFlowModulesRequest searchContactFlowModulesRequest) This is a variant ofsearchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
operation.default SearchContactFlowsResponse
searchContactFlows
(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest) Searches the contact flows in an Amazon Connect instance, with optional filtering.default SearchContactFlowsResponse
searchContactFlows
(SearchContactFlowsRequest searchContactFlowsRequest) Searches the contact flows in an Amazon Connect instance, with optional filtering.default SearchContactFlowsIterable
searchContactFlowsPaginator
(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest) This is a variant ofsearchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
operation.default SearchContactFlowsIterable
searchContactFlowsPaginator
(SearchContactFlowsRequest searchContactFlowsRequest) This is a variant ofsearchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
operation.default SearchContactsResponse
searchContacts
(Consumer<SearchContactsRequest.Builder> searchContactsRequest) Searches contacts in an Amazon Connect instance.default SearchContactsResponse
searchContacts
(SearchContactsRequest searchContactsRequest) Searches contacts in an Amazon Connect instance.default SearchContactsIterable
searchContactsPaginator
(Consumer<SearchContactsRequest.Builder> searchContactsRequest) This is a variant ofsearchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
operation.default SearchContactsIterable
searchContactsPaginator
(SearchContactsRequest searchContactsRequest) This is a variant ofsearchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
operation.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) This is a variant ofsearchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest)
operation.default SearchHoursOfOperationsIterable
searchHoursOfOperationsPaginator
(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) This is a variant ofsearchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest)
operation.searchPredefinedAttributes
(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest) Predefined attributes that meet certain criteria.searchPredefinedAttributes
(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest) Predefined attributes that meet certain criteria.searchPredefinedAttributesPaginator
(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest) This is a variant ofsearchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
operation.searchPredefinedAttributesPaginator
(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest) This is a variant ofsearchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
operation.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) This is a variant ofsearchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest)
operation.default SearchPromptsIterable
searchPromptsPaginator
(SearchPromptsRequest searchPromptsRequest) This is a variant ofsearchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest)
operation.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) This is a variant ofsearchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest)
operation.default SearchQueuesIterable
searchQueuesPaginator
(SearchQueuesRequest searchQueuesRequest) This is a variant ofsearchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest)
operation.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) This is a variant ofsearchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest)
operation.default SearchQuickConnectsIterable
searchQuickConnectsPaginator
(SearchQuickConnectsRequest searchQuickConnectsRequest) This is a variant ofsearchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest)
operation.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) This is a variant ofsearchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest)
operation.default SearchResourceTagsIterable
searchResourceTagsPaginator
(SearchResourceTagsRequest searchResourceTagsRequest) This is a variant ofsearchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest)
operation.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) This is a variant ofsearchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest)
operation.default SearchRoutingProfilesIterable
searchRoutingProfilesPaginator
(SearchRoutingProfilesRequest searchRoutingProfilesRequest) This is a variant ofsearchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest)
operation.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) This is a variant ofsearchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest)
operation.default SearchSecurityProfilesIterable
searchSecurityProfilesPaginator
(SearchSecurityProfilesRequest searchSecurityProfilesRequest) This is a variant ofsearchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest)
operation.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) This is a variant ofsearchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest)
operation.default SearchUsersIterable
searchUsersPaginator
(SearchUsersRequest searchUsersRequest) This is a variant ofsearchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest)
operation.default SearchVocabulariesResponse
searchVocabularies
(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance usingState
,NameStartsWith
, andLanguageCode
.default SearchVocabulariesResponse
searchVocabularies
(SearchVocabulariesRequest searchVocabulariesRequest) Searches for vocabularies within a specific Amazon Connect instance usingState
,NameStartsWith
, andLanguageCode
.default SearchVocabulariesIterable
searchVocabulariesPaginator
(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest) This is a variant ofsearchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest)
operation.default SearchVocabulariesIterable
searchVocabulariesPaginator
(SearchVocabulariesRequest searchVocabulariesRequest) This is a variant ofsearchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest)
operation.default SendChatIntegrationEventResponse
sendChatIntegrationEvent
(Consumer<SendChatIntegrationEventRequest.Builder> sendChatIntegrationEventRequest) Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.default SendChatIntegrationEventResponse
sendChatIntegrationEvent
(SendChatIntegrationEventRequest sendChatIntegrationEventRequest) Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartAttachedFileUploadResponse
startAttachedFileUpload
(Consumer<StartAttachedFileUploadRequest.Builder> startAttachedFileUploadRequest) Provides a pre-signed Amazon S3 URL in response for uploading your content.default StartAttachedFileUploadResponse
startAttachedFileUpload
(StartAttachedFileUploadRequest startAttachedFileUploadRequest) Provides a pre-signed Amazon S3 URL in response for uploading your content.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.startOutboundVoiceContact
(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest) Places an outbound call to a contact, and then initiates the flow.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 contact.default StartTaskContactResponse
startTaskContact
(StartTaskContactRequest startTaskContactRequest) Initiates a flow to start a new task contact.default StartWebRtcContactResponse
startWebRTCContact
(Consumer<StartWebRtcContactRequest.Builder> startWebRtcContactRequest) Places an inbound in-app, web, or video call to a contact, and then initiates the flow.default StartWebRtcContactResponse
startWebRTCContact
(StartWebRtcContactRequest startWebRtcContactRequest) Places an inbound in-app, web, or video call to a contact, and then initiates the flow.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 whatever is selected in the flow configuration: call, screen, or both.default SuspendContactRecordingResponse
suspendContactRecording
(SuspendContactRecordingRequest suspendContactRecordingRequest) When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.default TagContactResponse
tagContact
(Consumer<TagContactRequest.Builder> tagContactRequest) Adds the specified tags to the contact resource.default TagContactResponse
tagContact
(TagContactRequest tagContactRequest) Adds the specified tags to the contact resource.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 UntagContactResponse
untagContact
(Consumer<UntagContactRequest.Builder> untagContactRequest) Removes the specified tags from the contact resource.default UntagContactResponse
untagContact
(UntagContactRequest untagContactRequest) Removes the specified tags from the contact resource.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.updateContactFlowMetadata
(Consumer<UpdateContactFlowMetadataRequest.Builder> updateContactFlowMetadataRequest) Updates metadata about specified flow.updateContactFlowMetadata
(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest) Updates metadata about specified flow.updateContactFlowModuleContent
(Consumer<UpdateContactFlowModuleContentRequest.Builder> updateContactFlowModuleContentRequest) Updates specified flow module for the specified Amazon Connect instance.updateContactFlowModuleContent
(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest) Updates specified flow module for the specified Amazon Connect instance.updateContactFlowModuleMetadata
(Consumer<UpdateContactFlowModuleMetadataRequest.Builder> updateContactFlowModuleMetadataRequest) Updates metadata about specified flow module.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 UpdateContactRoutingDataResponse
updateContactRoutingData
(Consumer<UpdateContactRoutingDataRequest.Builder> updateContactRoutingDataRequest) This API is in preview release for Amazon Connect and is subject to change.default UpdateContactRoutingDataResponse
updateContactRoutingData
(UpdateContactRoutingDataRequest updateContactRoutingDataRequest) This API is in preview release for Amazon Connect and is subject to change.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.updateInstanceStorageConfig
(Consumer<UpdateInstanceStorageConfigRequest.Builder> updateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.updateInstanceStorageConfig
(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) This API is in preview release for Amazon Connect and is subject to change.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.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.updatePhoneNumberMetadata
(Consumer<UpdatePhoneNumberMetadataRequest.Builder> updatePhoneNumberMetadataRequest) Updates a phone number’s metadata.updatePhoneNumberMetadata
(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest) Updates a phone number’s metadata.updatePredefinedAttribute
(Consumer<UpdatePredefinedAttributeRequest.Builder> updatePredefinedAttributeRequest) Updates a predefined attribute for the specified Amazon Connect instance.updatePredefinedAttribute
(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest) Updates a predefined attribute for the specified Amazon Connect instance.default UpdatePromptResponse
updatePrompt
(Consumer<UpdatePromptRequest.Builder> updatePromptRequest) Updates a prompt.default UpdatePromptResponse
updatePrompt
(UpdatePromptRequest updatePromptRequest) Updates a prompt.updateQueueHoursOfOperation
(Consumer<UpdateQueueHoursOfOperationRequest.Builder> updateQueueHoursOfOperationRequest) This API is in preview release for Amazon Connect and is subject to change.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.updateQueueOutboundCallerConfig
(Consumer<UpdateQueueOutboundCallerConfigRequest.Builder> updateQueueOutboundCallerConfigRequest) This API is in preview release for Amazon Connect and is subject to change.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.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.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.updateRoutingProfileConcurrency
(Consumer<UpdateRoutingProfileConcurrencyRequest.Builder> updateRoutingProfileConcurrencyRequest) Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.updateRoutingProfileConcurrency
(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.updateRoutingProfileDefaultOutboundQueue
(Consumer<UpdateRoutingProfileDefaultOutboundQueueRequest.Builder> updateRoutingProfileDefaultOutboundQueueRequest) Updates the default outbound queue of a routing profile.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.updateRoutingProfileQueues
(Consumer<UpdateRoutingProfileQueuesRequest.Builder> updateRoutingProfileQueuesRequest) Updates the properties associated with a set of queues for a routing profile.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) Updates a security profile.default UpdateSecurityProfileResponse
updateSecurityProfile
(UpdateSecurityProfileRequest updateSecurityProfileRequest) Updates a security profile.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.updateTrafficDistribution
(Consumer<UpdateTrafficDistributionRequest.Builder> updateTrafficDistributionRequest) Updates the traffic distribution for a given traffic distribution group.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.updateUserHierarchyGroupName
(Consumer<UpdateUserHierarchyGroupNameRequest.Builder> updateUserHierarchyGroupNameRequest) Updates the name of the user hierarchy group.updateUserHierarchyGroupName
(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) Updates the name of the user hierarchy group.updateUserHierarchyStructure
(Consumer<UpdateUserHierarchyStructureRequest.Builder> updateUserHierarchyStructureRequest) Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.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 UpdateUserProficienciesResponse
updateUserProficiencies
(Consumer<UpdateUserProficienciesRequest.Builder> updateUserProficienciesRequest) Updates the properties associated with the proficiencies of a user.default UpdateUserProficienciesResponse
updateUserProficiencies
(UpdateUserProficienciesRequest updateUserProficienciesRequest) Updates the properties associated with the proficiencies of a 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.updateUserSecurityProfiles
(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest) Assigns the specified security profiles to the specified user.updateUserSecurityProfiles
(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) Assigns the specified security profiles to the specified user.default UpdateViewContentResponse
updateViewContent
(Consumer<UpdateViewContentRequest.Builder> updateViewContentRequest) Updates the view content of the given view identifier in the specified Amazon Connect instance.default UpdateViewContentResponse
updateViewContent
(UpdateViewContentRequest updateViewContentRequest) Updates the view content of the given view identifier in the specified Amazon Connect instance.default UpdateViewMetadataResponse
updateViewMetadata
(Consumer<UpdateViewMetadataRequest.Builder> updateViewMetadataRequest) Updates the view metadata.default UpdateViewMetadataResponse
updateViewMetadata
(UpdateViewMetadataRequest updateViewMetadataRequest) Updates the view metadata.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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 viaActivateEvaluationFormRequest.builder()
- Parameters:
activateEvaluationFormRequest
- AConsumer
that will call methods onActivateEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the ActivateEvaluationForm operation returned by the service.
- See Also:
-
associateAnalyticsDataSet
default AssociateAnalyticsDataSetResponse associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
- Parameters:
associateAnalyticsDataSetRequest
-- Returns:
- Result of the AssociateAnalyticsDataSet operation returned by the service.
- See Also:
-
associateAnalyticsDataSet
default AssociateAnalyticsDataSetResponse associateAnalyticsDataSet(Consumer<AssociateAnalyticsDataSetRequest.Builder> associateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
This is a convenience which creates an instance of the
AssociateAnalyticsDataSetRequest.Builder
avoiding the need to create one manually viaAssociateAnalyticsDataSetRequest.builder()
- Parameters:
associateAnalyticsDataSetRequest
- AConsumer
that will call methods onAssociateAnalyticsDataSetRequest.Builder
to create a request.- Returns:
- Result of the AssociateAnalyticsDataSet operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateApprovedOriginRequest.builder()
- Parameters:
associateApprovedOriginRequest
- AConsumer
that will call methods onAssociateApprovedOriginRequest.Builder
to create a request.- Returns:
- Result of the AssociateApprovedOrigin operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateBotRequest.builder()
- Parameters:
associateBotRequest
- AConsumer
that will call methods onAssociateBotRequest.Builder
to create a request.- Returns:
- Result of the AssociateBot operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateDefaultVocabularyRequest.builder()
- Parameters:
associateDefaultVocabularyRequest
- AConsumer
that will call methods onAssociateDefaultVocabularyRequest.Builder
to create a request.- Returns:
- Result of the AssociateDefaultVocabulary operation returned by the service.
- See Also:
-
associateFlow
default AssociateFlowResponse associateFlow(AssociateFlowRequest associateFlowRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Associates a connect resource to a flow.
- Parameters:
associateFlowRequest
-- Returns:
- Result of the AssociateFlow operation returned by the service.
- See Also:
-
associateFlow
default AssociateFlowResponse associateFlow(Consumer<AssociateFlowRequest.Builder> associateFlowRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Associates a connect resource to a flow.
This is a convenience which creates an instance of the
AssociateFlowRequest.Builder
avoiding the need to create one manually viaAssociateFlowRequest.builder()
- Parameters:
associateFlowRequest
- AConsumer
that will call methods onAssociateFlowRequest.Builder
to create a request.- Returns:
- Result of the AssociateFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateInstanceStorageConfigRequest.builder()
- Parameters:
associateInstanceStorageConfigRequest
- AConsumer
that will call methods onAssociateInstanceStorageConfigRequest.Builder
to create a request.- Returns:
- Result of the AssociateInstanceStorageConfig operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateLambdaFunctionRequest.builder()
- Parameters:
associateLambdaFunctionRequest
- AConsumer
that will call methods onAssociateLambdaFunctionRequest.Builder
to create a request.- Returns:
- Result of the AssociateLambdaFunction operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateLexBotRequest.builder()
- Parameters:
associateLexBotRequest
- AConsumer
that will call methods onAssociateLexBotRequest.Builder
to create a request.- Returns:
- Result of the AssociateLexBot operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.- Parameters:
associatePhoneNumberContactFlowRequest
-- Returns:
- Result of the AssociatePhoneNumberContactFlow operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.
This is a convenience which creates an instance of the
AssociatePhoneNumberContactFlowRequest.Builder
avoiding the need to create one manually viaAssociatePhoneNumberContactFlowRequest.builder()
- Parameters:
associatePhoneNumberContactFlowRequest
- AConsumer
that will call methods onAssociatePhoneNumberContactFlowRequest.Builder
to create a request.- Returns:
- Result of the AssociatePhoneNumberContactFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateQueueQuickConnectsRequest.builder()
- Parameters:
associateQueueQuickConnectsRequest
- AConsumer
that will call methods onAssociateQueueQuickConnectsRequest.Builder
to create a request.- Returns:
- Result of the AssociateQueueQuickConnects operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateRoutingProfileQueuesRequest.builder()
- Parameters:
associateRoutingProfileQueuesRequest
- AConsumer
that will call methods onAssociateRoutingProfileQueuesRequest.Builder
to create a request.- Returns:
- Result of the AssociateRoutingProfileQueues operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateSecurityKeyRequest.builder()
- Parameters:
associateSecurityKeyRequest
- AConsumer
that will call methods onAssociateSecurityKeyRequest.Builder
to create a request.- Returns:
- Result of the AssociateSecurityKey operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateTrafficDistributionGroupUserRequest.builder()
- Parameters:
associateTrafficDistributionGroupUserRequest
- AConsumer
that will call methods onAssociateTrafficDistributionGroupUserRequest.Builder
to create a request.- Returns:
- Result of the AssociateTrafficDistributionGroupUser operation returned by the service.
- See Also:
-
associateUserProficiencies
default AssociateUserProficienciesResponse associateUserProficiencies(AssociateUserProficienciesRequest associateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException >Associates a set of proficiencies with a user.
- Parameters:
associateUserProficienciesRequest
-- Returns:
- Result of the AssociateUserProficiencies operation returned by the service.
- See Also:
-
associateUserProficiencies
default AssociateUserProficienciesResponse associateUserProficiencies(Consumer<AssociateUserProficienciesRequest.Builder> associateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException >Associates a set of proficiencies with a user.
This is a convenience which creates an instance of the
AssociateUserProficienciesRequest.Builder
avoiding the need to create one manually viaAssociateUserProficienciesRequest.builder()
- Parameters:
associateUserProficienciesRequest
- AConsumer
that will call methods onAssociateUserProficienciesRequest.Builder
to create a request.- Returns:
- Result of the AssociateUserProficiencies operation returned by the service.
- See Also:
-
batchAssociateAnalyticsDataSet
default BatchAssociateAnalyticsDataSetResponse batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
- Parameters:
batchAssociateAnalyticsDataSetRequest
-- Returns:
- Result of the BatchAssociateAnalyticsDataSet operation returned by the service.
- See Also:
-
batchAssociateAnalyticsDataSet
default BatchAssociateAnalyticsDataSetResponse batchAssociateAnalyticsDataSet(Consumer<BatchAssociateAnalyticsDataSetRequest.Builder> batchAssociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
This is a convenience which creates an instance of the
BatchAssociateAnalyticsDataSetRequest.Builder
avoiding the need to create one manually viaBatchAssociateAnalyticsDataSetRequest.builder()
- Parameters:
batchAssociateAnalyticsDataSetRequest
- AConsumer
that will call methods onBatchAssociateAnalyticsDataSetRequest.Builder
to create a request.- Returns:
- Result of the BatchAssociateAnalyticsDataSet operation returned by the service.
- See Also:
-
batchDisassociateAnalyticsDataSet
default BatchDisassociateAnalyticsDataSetResponse batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
- Parameters:
batchDisassociateAnalyticsDataSetRequest
-- Returns:
- Result of the BatchDisassociateAnalyticsDataSet operation returned by the service.
- See Also:
-
batchDisassociateAnalyticsDataSet
default BatchDisassociateAnalyticsDataSetResponse batchDisassociateAnalyticsDataSet(Consumer<BatchDisassociateAnalyticsDataSetRequest.Builder> batchDisassociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
This is a convenience which creates an instance of the
BatchDisassociateAnalyticsDataSetRequest.Builder
avoiding the need to create one manually viaBatchDisassociateAnalyticsDataSetRequest.builder()
- Parameters:
batchDisassociateAnalyticsDataSetRequest
- AConsumer
that will call methods onBatchDisassociateAnalyticsDataSetRequest.Builder
to create a request.- Returns:
- Result of the BatchDisassociateAnalyticsDataSet operation returned by the service.
- See Also:
-
batchGetAttachedFileMetadata
default BatchGetAttachedFileMetadataResponse batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
- Parameters:
batchGetAttachedFileMetadataRequest
-- Returns:
- Result of the BatchGetAttachedFileMetadata operation returned by the service.
- See Also:
-
batchGetAttachedFileMetadata
default BatchGetAttachedFileMetadataResponse batchGetAttachedFileMetadata(Consumer<BatchGetAttachedFileMetadataRequest.Builder> batchGetAttachedFileMetadataRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
This is a convenience which creates an instance of the
BatchGetAttachedFileMetadataRequest.Builder
avoiding the need to create one manually viaBatchGetAttachedFileMetadataRequest.builder()
- Parameters:
batchGetAttachedFileMetadataRequest
- AConsumer
that will call methods onBatchGetAttachedFileMetadataRequest.Builder
to create a request.- Returns:
- Result of the BatchGetAttachedFileMetadata operation returned by the service.
- See Also:
-
batchGetFlowAssociation
default BatchGetFlowAssociationResponse batchGetFlowAssociation(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Retrieve the flow associations for the given resources.
- Parameters:
batchGetFlowAssociationRequest
-- Returns:
- Result of the BatchGetFlowAssociation operation returned by the service.
- See Also:
-
batchGetFlowAssociation
default BatchGetFlowAssociationResponse batchGetFlowAssociation(Consumer<BatchGetFlowAssociationRequest.Builder> batchGetFlowAssociationRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Retrieve the flow associations for the given resources.
This is a convenience which creates an instance of the
BatchGetFlowAssociationRequest.Builder
avoiding the need to create one manually viaBatchGetFlowAssociationRequest.builder()
- Parameters:
batchGetFlowAssociationRequest
- AConsumer
that will call methods onBatchGetFlowAssociationRequest.Builder
to create a request.- Returns:
- Result of the BatchGetFlowAssociation operation returned by the service.
- See Also:
-
batchPutContact
default BatchPutContactResponse batchPutContact(BatchPutContactRequest batchPutContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, ResourceNotFoundException, LimitExceededException, IdempotencyException, AwsServiceException, SdkClientException, ConnectException Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
- Parameters:
batchPutContactRequest
-- Returns:
- Result of the BatchPutContact operation returned by the service.
- See Also:
-
batchPutContact
default BatchPutContactResponse batchPutContact(Consumer<BatchPutContactRequest.Builder> batchPutContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, ResourceNotFoundException, LimitExceededException, IdempotencyException, AwsServiceException, SdkClientException, ConnectException Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
This is a convenience which creates an instance of the
BatchPutContactRequest.Builder
avoiding the need to create one manually viaBatchPutContactRequest.builder()
- Parameters:
batchPutContactRequest
- AConsumer
that will call methods onBatchPutContactRequest.Builder
to create a request.- Returns:
- Result of the BatchPutContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaClaimPhoneNumberRequest.builder()
- Parameters:
claimPhoneNumberRequest
- AConsumer
that will call methods onClaimPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the ClaimPhoneNumber operation returned by the service.
- See Also:
-
completeAttachedFileUpload
default CompleteAttachedFileUploadResponse completeAttachedFileUpload(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
- Parameters:
completeAttachedFileUploadRequest
- Request to CompleteAttachedFileUpload API- Returns:
- Result of the CompleteAttachedFileUpload operation returned by the service.
- See Also:
-
completeAttachedFileUpload
default CompleteAttachedFileUploadResponse completeAttachedFileUpload(Consumer<CompleteAttachedFileUploadRequest.Builder> completeAttachedFileUploadRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
This is a convenience which creates an instance of the
CompleteAttachedFileUploadRequest.Builder
avoiding the need to create one manually viaCompleteAttachedFileUploadRequest.builder()
- Parameters:
completeAttachedFileUploadRequest
- AConsumer
that will call methods onCompleteAttachedFileUploadRequest.Builder
to create a request. Request to CompleteAttachedFileUpload API- Returns:
- Result of the CompleteAttachedFileUpload operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateAgentStatusRequest.builder()
- Parameters:
createAgentStatusRequest
- AConsumer
that will call methods onCreateAgentStatusRequest.Builder
to create a request.- Returns:
- Result of the CreateAgentStatus operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateContactFlowRequest.builder()
- Parameters:
createContactFlowRequest
- AConsumer
that will call methods onCreateContactFlowRequest.Builder
to create a request.- Returns:
- Result of the CreateContactFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateContactFlowModuleRequest.builder()
- Parameters:
createContactFlowModuleRequest
- AConsumer
that will call methods onCreateContactFlowModuleRequest.Builder
to create a request.- Returns:
- Result of the CreateContactFlowModule operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateEvaluationFormRequest.builder()
- Parameters:
createEvaluationFormRequest
- AConsumer
that will call methods onCreateEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the CreateEvaluationForm operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateHoursOfOperationRequest.builder()
- Parameters:
createHoursOfOperationRequest
- AConsumer
that will call methods onCreateHoursOfOperationRequest.Builder
to create a request.- Returns:
- Result of the CreateHoursOfOperation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateInstanceRequest.builder()
- Parameters:
createInstanceRequest
- AConsumer
that will call methods onCreateInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateInstance operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateIntegrationAssociationRequest.builder()
- Parameters:
createIntegrationAssociationRequest
- AConsumer
that will call methods onCreateIntegrationAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateIntegrationAssociation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateParticipantRequest.builder()
- Parameters:
createParticipantRequest
- AConsumer
that will call methods onCreateParticipantRequest.Builder
to create a request.- Returns:
- Result of the CreateParticipant operation returned by the service.
- See Also:
-
createPersistentContactAssociation
default CreatePersistentContactAssociationResponse createPersistentContactAssociation(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
- Parameters:
createPersistentContactAssociationRequest
-- Returns:
- Result of the CreatePersistentContactAssociation operation returned by the service.
- See Also:
-
createPersistentContactAssociation
default CreatePersistentContactAssociationResponse createPersistentContactAssociation(Consumer<CreatePersistentContactAssociationRequest.Builder> createPersistentContactAssociationRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
CreatePersistentContactAssociationRequest.Builder
avoiding the need to create one manually viaCreatePersistentContactAssociationRequest.builder()
- Parameters:
createPersistentContactAssociationRequest
- AConsumer
that will call methods onCreatePersistentContactAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreatePersistentContactAssociation operation returned by the service.
- See Also:
-
createPredefinedAttribute
default CreatePredefinedAttributeResponse createPredefinedAttribute(CreatePredefinedAttributeRequest createPredefinedAttributeRequest) throws DuplicateResourceException, InvalidRequestException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Creates a new predefined attribute for the specified Amazon Connect instance.
- Parameters:
createPredefinedAttributeRequest
-- Returns:
- Result of the CreatePredefinedAttribute operation returned by the service.
- See Also:
-
createPredefinedAttribute
default CreatePredefinedAttributeResponse createPredefinedAttribute(Consumer<CreatePredefinedAttributeRequest.Builder> createPredefinedAttributeRequest) throws DuplicateResourceException, InvalidRequestException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Creates a new predefined attribute for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
CreatePredefinedAttributeRequest.Builder
avoiding the need to create one manually viaCreatePredefinedAttributeRequest.builder()
- Parameters:
createPredefinedAttributeRequest
- AConsumer
that will call methods onCreatePredefinedAttributeRequest.Builder
to create a request.- Returns:
- Result of the CreatePredefinedAttribute operation returned by the service.
- See Also:
-
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 Guide.
- Parameters:
createPromptRequest
-- Returns:
- Result of the CreatePrompt operation returned by the service.
- See Also:
-
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 Guide.
This is a convenience which creates an instance of the
CreatePromptRequest.Builder
avoiding the need to create one manually viaCreatePromptRequest.builder()
- Parameters:
createPromptRequest
- AConsumer
that will call methods onCreatePromptRequest.Builder
to create a request.- Returns:
- Result of the CreatePrompt operation returned by the service.
- See Also:
-
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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
. -
Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. -
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
- Parameters:
createQueueRequest
-- Returns:
- Result of the CreateQueue operation returned by the service.
- See Also:
-
-
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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
. -
Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. -
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
This is a convenience which creates an instance of the
CreateQueueRequest.Builder
avoiding the need to create one manually viaCreateQueueRequest.builder()
- Parameters:
createQueueRequest
- AConsumer
that will call methods onCreateQueueRequest.Builder
to create a request.- Returns:
- Result of the CreateQueue operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaCreateQuickConnectRequest.builder()
- Parameters:
createQuickConnectRequest
- AConsumer
that will call methods onCreateQuickConnectRequest.Builder
to create a request.- Returns:
- Result of the CreateQuickConnect operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateRoutingProfileRequest.builder()
- Parameters:
createRoutingProfileRequest
- AConsumer
that will call methods onCreateRoutingProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateRoutingProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateRuleRequest.builder()
- Parameters:
createRuleRequest
- AConsumer
that will call methods onCreateRuleRequest.Builder
to create a request.- Returns:
- Result of the CreateRule operation returned by the service.
- See Also:
-
createSecurityProfile
default CreateSecurityProfileResponse createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, LimitExceededException, DuplicateResourceException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Creates a security profile.
- Parameters:
createSecurityProfileRequest
-- Returns:
- Result of the CreateSecurityProfile operation returned by the service.
- See Also:
-
createSecurityProfile
default CreateSecurityProfileResponse createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, LimitExceededException, DuplicateResourceException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Creates a security profile.
This is a convenience which creates an instance of the
CreateSecurityProfileRequest.Builder
avoiding the need to create one manually viaCreateSecurityProfileRequest.builder()
- Parameters:
createSecurityProfileRequest
- AConsumer
that will call methods onCreateSecurityProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateSecurityProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateTaskTemplateRequest.builder()
- Parameters:
createTaskTemplateRequest
- AConsumer
that will call methods onCreateTaskTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateTaskTemplate operation returned by the service.
- See Also:
-
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.
The
SignInConfig
distribution is available only on a defaultTrafficDistributionGroup
(see theIsDefault
parameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistribution
with a modifiedSignInConfig
and a non-defaultTrafficDistributionGroup
, anInvalidRequestException
is returned.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.
- See Also:
-
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.
The
SignInConfig
distribution is available only on a defaultTrafficDistributionGroup
(see theIsDefault
parameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistribution
with a modifiedSignInConfig
and a non-defaultTrafficDistributionGroup
, anInvalidRequestException
is returned.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 viaCreateTrafficDistributionGroupRequest.builder()
- Parameters:
createTrafficDistributionGroupRequest
- AConsumer
that will call methods onCreateTrafficDistributionGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateTrafficDistributionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateUseCaseRequest.builder()
- Parameters:
createUseCaseRequest
- AConsumer
that will call methods onCreateUseCaseRequest.Builder
to create a request.- Returns:
- Result of the CreateUseCase operation returned by the service.
- See Also:
-
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.
Certain UserIdentityInfo parameters are required in some situations. For example,
Email
is required if you are using SAML for identity management.FirstName
andLastName
are required if you are using Amazon Connect or SAML for identity management.For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
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.
Certain UserIdentityInfo parameters are required in some situations. For example,
Email
is required if you are using SAML for identity management.FirstName
andLastName
are required if you are using Amazon Connect or SAML for identity management.For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateUserHierarchyGroupRequest.builder()
- Parameters:
createUserHierarchyGroupRequest
- AConsumer
that will call methods onCreateUserHierarchyGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateUserHierarchyGroup operation returned by the service.
- See Also:
-
createView
default CreateViewResponse createView(CreateViewRequest createViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, DuplicateResourceException, ServiceQuotaExceededException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Creates a new view with the possible status of
SAVED
orPUBLISHED
.The views will have a unique name for each connect instance.
It performs basic content validation if the status is
SAVED
or full content validation if the status is set toPUBLISHED
. An error is returned if validation fails. It associates either theinvalid input: '$'SAVED
qualifier or both of theinvalid input: '$'SAVED
andinvalid input: '$'LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.- Parameters:
createViewRequest
-- Returns:
- Result of the CreateView operation returned by the service.
- See Also:
-
createView
default CreateViewResponse createView(Consumer<CreateViewRequest.Builder> createViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, DuplicateResourceException, ServiceQuotaExceededException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Creates a new view with the possible status of
SAVED
orPUBLISHED
.The views will have a unique name for each connect instance.
It performs basic content validation if the status is
SAVED
or full content validation if the status is set toPUBLISHED
. An error is returned if validation fails. It associates either theinvalid input: '$'SAVED
qualifier or both of theinvalid input: '$'SAVED
andinvalid input: '$'LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
This is a convenience which creates an instance of the
CreateViewRequest.Builder
avoiding the need to create one manually viaCreateViewRequest.builder()
- Parameters:
createViewRequest
- AConsumer
that will call methods onCreateViewRequest.Builder
to create a request.- Returns:
- Result of the CreateView operation returned by the service.
- See Also:
-
createViewVersion
default CreateViewVersionResponse createViewVersion(CreateViewVersionRequest createViewVersionRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ServiceQuotaExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the
invalid input: '$'LATEST
alias.- Parameters:
createViewVersionRequest
-- Returns:
- Result of the CreateViewVersion operation returned by the service.
- See Also:
-
createViewVersion
default CreateViewVersionResponse createViewVersion(Consumer<CreateViewVersionRequest.Builder> createViewVersionRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ServiceQuotaExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the
invalid input: '$'LATEST
alias.
This is a convenience which creates an instance of the
CreateViewVersionRequest.Builder
avoiding the need to create one manually viaCreateViewVersionRequest.builder()
- Parameters:
createViewVersionRequest
- AConsumer
that will call methods onCreateViewVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateViewVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateVocabularyRequest.builder()
- Parameters:
createVocabularyRequest
- AConsumer
that will call methods onCreateVocabularyRequest.Builder
to create a request.- Returns:
- Result of the CreateVocabulary operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeactivateEvaluationFormRequest.builder()
- Parameters:
deactivateEvaluationFormRequest
- AConsumer
that will call methods onDeactivateEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the DeactivateEvaluationForm operation returned by the service.
- See Also:
-
deleteAttachedFile
default DeleteAttachedFileResponse deleteAttachedFile(DeleteAttachedFileRequest deleteAttachedFileRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
- Parameters:
deleteAttachedFileRequest
- Request to DeleteAttachedFile API- Returns:
- Result of the DeleteAttachedFile operation returned by the service.
- See Also:
-
deleteAttachedFile
default DeleteAttachedFileResponse deleteAttachedFile(Consumer<DeleteAttachedFileRequest.Builder> deleteAttachedFileRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
This is a convenience which creates an instance of the
DeleteAttachedFileRequest.Builder
avoiding the need to create one manually viaDeleteAttachedFileRequest.builder()
- Parameters:
deleteAttachedFileRequest
- AConsumer
that will call methods onDeleteAttachedFileRequest.Builder
to create a request. Request to DeleteAttachedFile API- Returns:
- Result of the DeleteAttachedFile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteContactEvaluationRequest.builder()
- Parameters:
deleteContactEvaluationRequest
- AConsumer
that will call methods onDeleteContactEvaluationRequest.Builder
to create a request.- Returns:
- Result of the DeleteContactEvaluation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteContactFlowRequest.builder()
- Parameters:
deleteContactFlowRequest
- AConsumer
that will call methods onDeleteContactFlowRequest.Builder
to create a request.- Returns:
- Result of the DeleteContactFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteContactFlowModuleRequest.builder()
- Parameters:
deleteContactFlowModuleRequest
- AConsumer
that will call methods onDeleteContactFlowModuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteContactFlowModule operation returned by the service.
- See Also:
-
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.
- See Also:
-
-
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 viaDeleteEvaluationFormRequest.builder()
- Parameters:
deleteEvaluationFormRequest
- AConsumer
that will call methods onDeleteEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the DeleteEvaluationForm operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaDeleteHoursOfOperationRequest.builder()
- Parameters:
deleteHoursOfOperationRequest
- AConsumer
that will call methods onDeleteHoursOfOperationRequest.Builder
to create a request.- Returns:
- Result of the DeleteHoursOfOperation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteInstanceRequest.builder()
- Parameters:
deleteInstanceRequest
- AConsumer
that will call methods onDeleteInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteIntegrationAssociationRequest.builder()
- Parameters:
deleteIntegrationAssociationRequest
- AConsumer
that will call methods onDeleteIntegrationAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteIntegrationAssociation operation returned by the service.
- See Also:
-
deletePredefinedAttribute
default DeletePredefinedAttributeResponse deletePredefinedAttribute(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest) throws ResourceInUseException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Deletes a predefined attribute from the specified Amazon Connect instance.
- Parameters:
deletePredefinedAttributeRequest
-- Returns:
- Result of the DeletePredefinedAttribute operation returned by the service.
- See Also:
-
deletePredefinedAttribute
default DeletePredefinedAttributeResponse deletePredefinedAttribute(Consumer<DeletePredefinedAttributeRequest.Builder> deletePredefinedAttributeRequest) throws ResourceInUseException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Deletes a predefined attribute from the specified Amazon Connect instance.
This is a convenience which creates an instance of the
DeletePredefinedAttributeRequest.Builder
avoiding the need to create one manually viaDeletePredefinedAttributeRequest.builder()
- Parameters:
deletePredefinedAttributeRequest
- AConsumer
that will call methods onDeletePredefinedAttributeRequest.Builder
to create a request.- Returns:
- Result of the DeletePredefinedAttribute operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeletePromptRequest.builder()
- Parameters:
deletePromptRequest
- AConsumer
that will call methods onDeletePromptRequest.Builder
to create a request.- Returns:
- Result of the DeletePrompt operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteQueueRequest.builder()
- Parameters:
deleteQueueRequest
- AConsumer
that will call methods onDeleteQueueRequest.Builder
to create a request.- Returns:
- Result of the DeleteQueue operation returned by the service.
- See Also:
-
deleteQuickConnect
default DeleteQuickConnectResponse deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Deletes a quick connect.
After calling DeleteUser, it's important to call
DeleteQuickConnect
to delete any records related to the deleted users. This will help you:-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
- Parameters:
deleteQuickConnectRequest
-- Returns:
- Result of the DeleteQuickConnect operation returned by the service.
- See Also:
-
-
deleteQuickConnect
default DeleteQuickConnectResponse deleteQuickConnect(Consumer<DeleteQuickConnectRequest.Builder> deleteQuickConnectRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Deletes a quick connect.
After calling DeleteUser, it's important to call
DeleteQuickConnect
to delete any records related to the deleted users. This will help you:-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
This is a convenience which creates an instance of the
DeleteQuickConnectRequest.Builder
avoiding the need to create one manually viaDeleteQuickConnectRequest.builder()
- Parameters:
deleteQuickConnectRequest
- AConsumer
that will call methods onDeleteQuickConnectRequest.Builder
to create a request.- Returns:
- Result of the DeleteQuickConnect operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaDeleteRoutingProfileRequest.builder()
- Parameters:
deleteRoutingProfileRequest
- AConsumer
that will call methods onDeleteRoutingProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteRoutingProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteRuleRequest.builder()
- Parameters:
deleteRuleRequest
- AConsumer
that will call methods onDeleteRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteRule operation returned by the service.
- See Also:
-
deleteSecurityProfile
default DeleteSecurityProfileResponse deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AccessDeniedException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes a security profile.
- Parameters:
deleteSecurityProfileRequest
-- Returns:
- Result of the DeleteSecurityProfile operation returned by the service.
- See Also:
-
deleteSecurityProfile
default DeleteSecurityProfileResponse deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AccessDeniedException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes a security profile.
This is a convenience which creates an instance of the
DeleteSecurityProfileRequest.Builder
avoiding the need to create one manually viaDeleteSecurityProfileRequest.builder()
- Parameters:
deleteSecurityProfileRequest
- AConsumer
that will call methods onDeleteSecurityProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteSecurityProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteTaskTemplateRequest.builder()
- Parameters:
deleteTaskTemplateRequest
- AConsumer
that will call methods onDeleteTaskTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteTaskTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteTrafficDistributionGroupRequest.builder()
- Parameters:
deleteTrafficDistributionGroupRequest
- AConsumer
that will call methods onDeleteTrafficDistributionGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteTrafficDistributionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteUseCaseRequest.builder()
- Parameters:
deleteUseCaseRequest
- AConsumer
that will call methods onDeleteUseCaseRequest.Builder
to create a request.- Returns:
- Result of the DeleteUseCase operation returned by the service.
- See Also:
-
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.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
- Parameters:
deleteUserRequest
-- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
-
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.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
-
Avoid dangling resources that impact your service quotas.
-
Remove deleted users so they don't appear to agents as transfer options.
-
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaDeleteUserHierarchyGroupRequest.builder()
- Parameters:
deleteUserHierarchyGroupRequest
- AConsumer
that will call methods onDeleteUserHierarchyGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteUserHierarchyGroup operation returned by the service.
- See Also:
-
deleteView
default DeleteViewResponse deleteView(DeleteViewRequest deleteViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
- Parameters:
deleteViewRequest
-- Returns:
- Result of the DeleteView operation returned by the service.
- See Also:
-
deleteView
default DeleteViewResponse deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
This is a convenience which creates an instance of the
DeleteViewRequest.Builder
avoiding the need to create one manually viaDeleteViewRequest.builder()
- Parameters:
deleteViewRequest
- AConsumer
that will call methods onDeleteViewRequest.Builder
to create a request.- Returns:
- Result of the DeleteView operation returned by the service.
- See Also:
-
deleteViewVersion
default DeleteViewVersionResponse deleteViewVersion(DeleteViewVersionRequest deleteViewVersionRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes the particular version specified in
ViewVersion
identifier.- Parameters:
deleteViewVersionRequest
-- Returns:
- Result of the DeleteViewVersion operation returned by the service.
- See Also:
-
deleteViewVersion
default DeleteViewVersionResponse deleteViewVersion(Consumer<DeleteViewVersionRequest.Builder> deleteViewVersionRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Deletes the particular version specified in
ViewVersion
identifier.
This is a convenience which creates an instance of the
DeleteViewVersionRequest.Builder
avoiding the need to create one manually viaDeleteViewVersionRequest.builder()
- Parameters:
deleteViewVersionRequest
- AConsumer
that will call methods onDeleteViewVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteViewVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteVocabularyRequest.builder()
- Parameters:
deleteVocabularyRequest
- AConsumer
that will call methods onDeleteVocabularyRequest.Builder
to create a request.- Returns:
- Result of the DeleteVocabulary operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeAgentStatusRequest.builder()
- Parameters:
describeAgentStatusRequest
- AConsumer
that will call methods onDescribeAgentStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeAgentStatus operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeContactRequest.builder()
- Parameters:
describeContactRequest
- AConsumer
that will call methods onDescribeContactRequest.Builder
to create a request.- Returns:
- Result of the DescribeContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeContactEvaluationRequest.builder()
- Parameters:
describeContactEvaluationRequest
- AConsumer
that will call methods onDescribeContactEvaluationRequest.Builder
to create a request.- Returns:
- Result of the DescribeContactEvaluation operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.In the response, Status indicates the flow status as either
SAVED
orPUBLISHED
. ThePUBLISHED
status will initiate validation on the content.SAVED
does not initiate validation of the content.SAVED
|PUBLISHED
- Parameters:
describeContactFlowRequest
-- Returns:
- Result of the DescribeContactFlow operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.In the response, Status indicates the flow status as either
SAVED
orPUBLISHED
. ThePUBLISHED
status will initiate validation on the content.SAVED
does not initiate validation of the content.SAVED
|PUBLISHED
This is a convenience which creates an instance of the
DescribeContactFlowRequest.Builder
avoiding the need to create one manually viaDescribeContactFlowRequest.builder()
- Parameters:
describeContactFlowRequest
- AConsumer
that will call methods onDescribeContactFlowRequest.Builder
to create a request.- Returns:
- Result of the DescribeContactFlow operation returned by the service.
- See Also:
-
describeContactFlowModule
default DescribeContactFlowModuleResponse describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes the specified flow module.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.- Parameters:
describeContactFlowModuleRequest
-- Returns:
- Result of the DescribeContactFlowModule operation returned by the service.
- See Also:
-
describeContactFlowModule
default DescribeContactFlowModuleResponse describeContactFlowModule(Consumer<DescribeContactFlowModuleRequest.Builder> describeContactFlowModuleRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes the specified flow module.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.
This is a convenience which creates an instance of the
DescribeContactFlowModuleRequest.Builder
avoiding the need to create one manually viaDescribeContactFlowModuleRequest.builder()
- Parameters:
describeContactFlowModuleRequest
- AConsumer
that will call methods onDescribeContactFlowModuleRequest.Builder
to create a request.- Returns:
- Result of the DescribeContactFlowModule operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeEvaluationFormRequest.builder()
- Parameters:
describeEvaluationFormRequest
- AConsumer
that will call methods onDescribeEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the DescribeEvaluationForm operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeHoursOfOperationRequest.builder()
- Parameters:
describeHoursOfOperationRequest
- AConsumer
that will call methods onDescribeHoursOfOperationRequest.Builder
to create a request.- Returns:
- Result of the DescribeHoursOfOperation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeInstanceRequest.builder()
- Parameters:
describeInstanceRequest
- AConsumer
that will call methods onDescribeInstanceRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstance operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeInstanceAttributeRequest.builder()
- Parameters:
describeInstanceAttributeRequest
- AConsumer
that will call methods onDescribeInstanceAttributeRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstanceAttribute operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeInstanceStorageConfigRequest.builder()
- Parameters:
describeInstanceStorageConfigRequest
- AConsumer
that will call methods onDescribeInstanceStorageConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstanceStorageConfig operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.- Parameters:
describePhoneNumberRequest
-- Returns:
- Result of the DescribePhoneNumber operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.
This is a convenience which creates an instance of the
DescribePhoneNumberRequest.Builder
avoiding the need to create one manually viaDescribePhoneNumberRequest.builder()
- Parameters:
describePhoneNumberRequest
- AConsumer
that will call methods onDescribePhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the DescribePhoneNumber operation returned by the service.
- See Also:
-
describePredefinedAttribute
default DescribePredefinedAttributeResponse describePredefinedAttribute(DescribePredefinedAttributeRequest describePredefinedAttributeRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes a predefined attribute for the specified Amazon Connect instance.
- Parameters:
describePredefinedAttributeRequest
-- Returns:
- Result of the DescribePredefinedAttribute operation returned by the service.
- See Also:
-
describePredefinedAttribute
default DescribePredefinedAttributeResponse describePredefinedAttribute(Consumer<DescribePredefinedAttributeRequest.Builder> describePredefinedAttributeRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes a predefined attribute for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
DescribePredefinedAttributeRequest.Builder
avoiding the need to create one manually viaDescribePredefinedAttributeRequest.builder()
- Parameters:
describePredefinedAttributeRequest
- AConsumer
that will call methods onDescribePredefinedAttributeRequest.Builder
to create a request.- Returns:
- Result of the DescribePredefinedAttribute operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribePromptRequest.builder()
- Parameters:
describePromptRequest
- AConsumer
that will call methods onDescribePromptRequest.Builder
to create a request.- Returns:
- Result of the DescribePrompt operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeQueueRequest.builder()
- Parameters:
describeQueueRequest
- AConsumer
that will call methods onDescribeQueueRequest.Builder
to create a request.- Returns:
- Result of the DescribeQueue operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeQuickConnectRequest.builder()
- Parameters:
describeQuickConnectRequest
- AConsumer
that will call methods onDescribeQuickConnectRequest.Builder
to create a request.- Returns:
- Result of the DescribeQuickConnect operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeRoutingProfileRequest.builder()
- Parameters:
describeRoutingProfileRequest
- AConsumer
that will call methods onDescribeRoutingProfileRequest.Builder
to create a request.- Returns:
- Result of the DescribeRoutingProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeRuleRequest.builder()
- Parameters:
describeRuleRequest
- AConsumer
that will call methods onDescribeRuleRequest.Builder
to create a request.- Returns:
- Result of the DescribeRule operation returned by the service.
- See Also:
-
describeSecurityProfile
default DescribeSecurityProfileResponse describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Gets basic information about the security profle.
- Parameters:
describeSecurityProfileRequest
-- Returns:
- Result of the DescribeSecurityProfile operation returned by the service.
- See Also:
-
describeSecurityProfile
default DescribeSecurityProfileResponse describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 viaDescribeSecurityProfileRequest.builder()
- Parameters:
describeSecurityProfileRequest
- AConsumer
that will call methods onDescribeSecurityProfileRequest.Builder
to create a request.- Returns:
- Result of the DescribeSecurityProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeTrafficDistributionGroupRequest.builder()
- Parameters:
describeTrafficDistributionGroupRequest
- AConsumer
that will call methods onDescribeTrafficDistributionGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrafficDistributionGroup operation returned by the service.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
- Parameters:
describeUserRequest
-- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeUserHierarchyGroupRequest.builder()
- Parameters:
describeUserHierarchyGroupRequest
- AConsumer
that will call methods onDescribeUserHierarchyGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeUserHierarchyGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeUserHierarchyStructureRequest.builder()
- Parameters:
describeUserHierarchyStructureRequest
- AConsumer
that will call methods onDescribeUserHierarchyStructureRequest.Builder
to create a request.- Returns:
- Result of the DescribeUserHierarchyStructure operation returned by the service.
- See Also:
-
describeView
default DescribeViewResponse describeView(DescribeViewRequest describeViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
invalid input: '$'SAVED
needs to be supplied if a view is unpublished.The view identifier can contain an optional qualifier, for example,
<view-id>:invalid input: '$'SAVED
, which is either an actual version number or an Amazon Connect managed qualifierinvalid input: '$'SAVED | invalid input: '$'LATEST
. If it is not supplied, theninvalid input: '$'LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.- Parameters:
describeViewRequest
-- Returns:
- Result of the DescribeView operation returned by the service.
- See Also:
-
describeView
default DescribeViewResponse describeView(Consumer<DescribeViewRequest.Builder> describeViewRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
invalid input: '$'SAVED
needs to be supplied if a view is unpublished.The view identifier can contain an optional qualifier, for example,
<view-id>:invalid input: '$'SAVED
, which is either an actual version number or an Amazon Connect managed qualifierinvalid input: '$'SAVED | invalid input: '$'LATEST
. If it is not supplied, theninvalid input: '$'LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
This is a convenience which creates an instance of the
DescribeViewRequest.Builder
avoiding the need to create one manually viaDescribeViewRequest.builder()
- Parameters:
describeViewRequest
- AConsumer
that will call methods onDescribeViewRequest.Builder
to create a request.- Returns:
- Result of the DescribeView operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeVocabularyRequest.builder()
- Parameters:
describeVocabularyRequest
- AConsumer
that will call methods onDescribeVocabularyRequest.Builder
to create a request.- Returns:
- Result of the DescribeVocabulary operation returned by the service.
- See Also:
-
disassociateAnalyticsDataSet
default DisassociateAnalyticsDataSetResponse disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
- Parameters:
disassociateAnalyticsDataSetRequest
-- Returns:
- Result of the DisassociateAnalyticsDataSet operation returned by the service.
- See Also:
-
disassociateAnalyticsDataSet
default DisassociateAnalyticsDataSetResponse disassociateAnalyticsDataSet(Consumer<DisassociateAnalyticsDataSetRequest.Builder> disassociateAnalyticsDataSetRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
This is a convenience which creates an instance of the
DisassociateAnalyticsDataSetRequest.Builder
avoiding the need to create one manually viaDisassociateAnalyticsDataSetRequest.builder()
- Parameters:
disassociateAnalyticsDataSetRequest
- AConsumer
that will call methods onDisassociateAnalyticsDataSetRequest.Builder
to create a request.- Returns:
- Result of the DisassociateAnalyticsDataSet operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateApprovedOriginRequest.builder()
- Parameters:
disassociateApprovedOriginRequest
- AConsumer
that will call methods onDisassociateApprovedOriginRequest.Builder
to create a request.- Returns:
- Result of the DisassociateApprovedOrigin operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateBotRequest.builder()
- Parameters:
disassociateBotRequest
- AConsumer
that will call methods onDisassociateBotRequest.Builder
to create a request.- Returns:
- Result of the DisassociateBot operation returned by the service.
- See Also:
-
disassociateFlow
default DisassociateFlowResponse disassociateFlow(DisassociateFlowRequest disassociateFlowRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Disassociates a connect resource from a flow.
- Parameters:
disassociateFlowRequest
-- Returns:
- Result of the DisassociateFlow operation returned by the service.
- See Also:
-
disassociateFlow
default DisassociateFlowResponse disassociateFlow(Consumer<DisassociateFlowRequest.Builder> disassociateFlowRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Disassociates a connect resource from a flow.
This is a convenience which creates an instance of the
DisassociateFlowRequest.Builder
avoiding the need to create one manually viaDisassociateFlowRequest.builder()
- Parameters:
disassociateFlowRequest
- AConsumer
that will call methods onDisassociateFlowRequest.Builder
to create a request.- Returns:
- Result of the DisassociateFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateInstanceStorageConfigRequest.builder()
- Parameters:
disassociateInstanceStorageConfigRequest
- AConsumer
that will call methods onDisassociateInstanceStorageConfigRequest.Builder
to create a request.- Returns:
- Result of the DisassociateInstanceStorageConfig operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateLambdaFunctionRequest.builder()
- Parameters:
disassociateLambdaFunctionRequest
- AConsumer
that will call methods onDisassociateLambdaFunctionRequest.Builder
to create a request.- Returns:
- Result of the DisassociateLambdaFunction operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateLexBotRequest.builder()
- Parameters:
disassociateLexBotRequest
- AConsumer
that will call methods onDisassociateLexBotRequest.Builder
to create a request.- Returns:
- Result of the DisassociateLexBot operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.- Parameters:
disassociatePhoneNumberContactFlowRequest
-- Returns:
- Result of the DisassociatePhoneNumberContactFlow operation returned by the service.
- See Also:
-
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 aResourceNotFoundException
.
This is a convenience which creates an instance of the
DisassociatePhoneNumberContactFlowRequest.Builder
avoiding the need to create one manually viaDisassociatePhoneNumberContactFlowRequest.builder()
- Parameters:
disassociatePhoneNumberContactFlowRequest
- AConsumer
that will call methods onDisassociatePhoneNumberContactFlowRequest.Builder
to create a request.- Returns:
- Result of the DisassociatePhoneNumberContactFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateQueueQuickConnectsRequest.builder()
- Parameters:
disassociateQueueQuickConnectsRequest
- AConsumer
that will call methods onDisassociateQueueQuickConnectsRequest.Builder
to create a request.- Returns:
- Result of the DisassociateQueueQuickConnects operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateRoutingProfileQueuesRequest.builder()
- Parameters:
disassociateRoutingProfileQueuesRequest
- AConsumer
that will call methods onDisassociateRoutingProfileQueuesRequest.Builder
to create a request.- Returns:
- Result of the DisassociateRoutingProfileQueues operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateSecurityKeyRequest.builder()
- Parameters:
disassociateSecurityKeyRequest
- AConsumer
that will call methods onDisassociateSecurityKeyRequest.Builder
to create a request.- Returns:
- Result of the DisassociateSecurityKey operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateTrafficDistributionGroupUserRequest.builder()
- Parameters:
disassociateTrafficDistributionGroupUserRequest
- AConsumer
that will call methods onDisassociateTrafficDistributionGroupUserRequest.Builder
to create a request.- Returns:
- Result of the DisassociateTrafficDistributionGroupUser operation returned by the service.
- See Also:
-
disassociateUserProficiencies
default DisassociateUserProficienciesResponse disassociateUserProficiencies(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Disassociates a set of proficiencies from a user.
- Parameters:
disassociateUserProficienciesRequest
-- Returns:
- Result of the DisassociateUserProficiencies operation returned by the service.
- See Also:
-
disassociateUserProficiencies
default DisassociateUserProficienciesResponse disassociateUserProficiencies(Consumer<DisassociateUserProficienciesRequest.Builder> disassociateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Disassociates a set of proficiencies from a user.
This is a convenience which creates an instance of the
DisassociateUserProficienciesRequest.Builder
avoiding the need to create one manually viaDisassociateUserProficienciesRequest.builder()
- Parameters:
disassociateUserProficienciesRequest
- AConsumer
that will call methods onDisassociateUserProficienciesRequest.Builder
to create a request.- Returns:
- Result of the DisassociateUserProficiencies operation returned by the service.
- See Also:
-
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
, orREJECTED
state in the Agent Event Stream.- Parameters:
dismissUserContactRequest
-- Returns:
- Result of the DismissUserContact operation returned by the service.
- See Also:
-
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
, orREJECTED
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 viaDismissUserContactRequest.builder()
- Parameters:
dismissUserContactRequest
- AConsumer
that will call methods onDismissUserContactRequest.Builder
to create a request.- Returns:
- Result of the DismissUserContact operation returned by the service.
- See Also:
-
getAttachedFile
default GetAttachedFileResponse getAttachedFile(GetAttachedFileRequest getAttachedFileRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is
APPROVED
.- Parameters:
getAttachedFileRequest
- Request to GetAttachedFile API.- Returns:
- Result of the GetAttachedFile operation returned by the service.
- See Also:
-
getAttachedFile
default GetAttachedFileResponse getAttachedFile(Consumer<GetAttachedFileRequest.Builder> getAttachedFileRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is
APPROVED
.
This is a convenience which creates an instance of the
GetAttachedFileRequest.Builder
avoiding the need to create one manually viaGetAttachedFileRequest.builder()
- Parameters:
getAttachedFileRequest
- AConsumer
that will call methods onGetAttachedFileRequest.Builder
to create a request. Request to GetAttachedFile API.- Returns:
- Result of the GetAttachedFile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetContactAttributesRequest.builder()
- Parameters:
getContactAttributesRequest
- AConsumer
that will call methods onGetContactAttributesRequest.Builder
to create a request.- Returns:
- Result of the GetContactAttributes operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetCurrentMetricDataRequest.builder()
- Parameters:
getCurrentMetricDataRequest
- AConsumer
that will call methods onGetCurrentMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetCurrentMetricData operation returned by the service.
- See Also:
-
getCurrentMetricDataPaginator
default GetCurrentMetricDataIterable getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
getCurrentMetricDataPaginator
default GetCurrentMetricDataIterable getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataIterable responses = client.getCurrentMetricDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetCurrentMetricDataRequest.builder()
- Parameters:
getCurrentMetricDataRequest
- AConsumer
that will call methods onGetCurrentMetricDataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaGetCurrentUserDataRequest.builder()
- Parameters:
getCurrentUserDataRequest
- AConsumer
that will call methods onGetCurrentUserDataRequest.Builder
to create a request.- Returns:
- Result of the GetCurrentUserData operation returned by the service.
- See Also:
-
getCurrentUserDataPaginator
default GetCurrentUserDataIterable getCurrentUserDataPaginator(GetCurrentUserDataRequest getCurrentUserDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
getCurrentUserDataPaginator
default GetCurrentUserDataIterable getCurrentUserDataPaginator(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetCurrentUserDataIterable responses = client.getCurrentUserDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetCurrentUserDataRequest.builder()
- Parameters:
getCurrentUserDataRequest
- AConsumer
that will call methods onGetCurrentUserDataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getFederationToken
default GetFederationTokenResponse getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, UserNotFoundException, InternalServiceException, DuplicateResourceException, AwsServiceException, SdkClientException, ConnectException Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
- Parameters:
getFederationTokenRequest
-- Returns:
- Result of the GetFederationToken operation returned by the service.
- See Also:
-
getFederationToken
default GetFederationTokenResponse getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, UserNotFoundException, InternalServiceException, DuplicateResourceException, AwsServiceException, SdkClientException, ConnectException Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
This is a convenience which creates an instance of the
GetFederationTokenRequest.Builder
avoiding the need to create one manually viaGetFederationTokenRequest.builder()
- Parameters:
getFederationTokenRequest
- AConsumer
that will call methods onGetFederationTokenRequest.Builder
to create a request.- Returns:
- Result of the GetFederationToken operation returned by the service.
- See Also:
-
getFlowAssociation
default GetFlowAssociationResponse getFlowAssociation(GetFlowAssociationRequest getFlowAssociationRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Retrieves the flow associated for a given resource.
- Parameters:
getFlowAssociationRequest
-- Returns:
- Result of the GetFlowAssociation operation returned by the service.
- See Also:
-
getFlowAssociation
default GetFlowAssociationResponse getFlowAssociation(Consumer<GetFlowAssociationRequest.Builder> getFlowAssociationRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Retrieves the flow associated for a given resource.
This is a convenience which creates an instance of the
GetFlowAssociationRequest.Builder
avoiding the need to create one manually viaGetFlowAssociationRequest.builder()
- Parameters:
getFlowAssociationRequest
- AConsumer
that will call methods onGetFlowAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetFlowAssociation operation returned by the service.
- See Also:
-
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.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.- Parameters:
getMetricDataRequest
-- Returns:
- Result of the GetMetricData operation returned by the service.
- See Also:
-
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.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
This is a convenience which creates an instance of the
GetMetricDataRequest.Builder
avoiding the need to create one manually viaGetMetricDataRequest.builder()
- Parameters:
getMetricDataRequest
- AConsumer
that will call methods onGetMetricDataRequest.Builder
to create a request.- Returns:
- Result of the GetMetricData operation returned by the service.
- See Also:
-
getMetricDataPaginator
default GetMetricDataIterable getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
getMetricDataPaginator
default GetMetricDataIterable getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetMetricDataRequest.builder()
- Parameters:
getMetricDataRequest
- AConsumer
that will call methods onGetMetricDataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 3 months, at varying intervals.For a description of the historical metrics that are supported by
GetMetricDataV2
andGetMetricData
, see Historical metrics definitions in the Amazon Connect Administrator Guide.- Parameters:
getMetricDataV2Request
-- Returns:
- Result of the GetMetricDataV2 operation returned by the service.
- See Also:
-
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 3 months, at varying intervals.For a description of the historical metrics that are supported by
GetMetricDataV2
andGetMetricData
, see Historical metrics definitions in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
GetMetricDataV2Request.Builder
avoiding the need to create one manually viaGetMetricDataV2Request.builder()
- Parameters:
getMetricDataV2Request
- AConsumer
that will call methods onGetMetricDataV2Request.Builder
to create a request.- Returns:
- Result of the GetMetricDataV2 operation returned by the service.
- See Also:
-
getMetricDataV2Paginator
default GetMetricDataV2Iterable getMetricDataV2Paginator(GetMetricDataV2Request getMetricDataV2Request) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
getMetricDataV2Paginator
default GetMetricDataV2Iterable getMetricDataV2Paginator(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request) throws InvalidRequestException, InvalidParameterException, InternalServiceException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.GetMetricDataV2Iterable responses = client.getMetricDataV2Paginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetMetricDataV2Request.builder()
- Parameters:
getMetricDataV2Request
- AConsumer
that will call methods onGetMetricDataV2Request.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaGetPromptFileRequest.builder()
- Parameters:
getPromptFileRequest
- AConsumer
that will call methods onGetPromptFileRequest.Builder
to create a request.- Returns:
- Result of the GetPromptFile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetTaskTemplateRequest.builder()
- Parameters:
getTaskTemplateRequest
- AConsumer
that will call methods onGetTaskTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetTaskTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetTrafficDistributionRequest.builder()
- Parameters:
getTrafficDistributionRequest
- AConsumer
that will call methods onGetTrafficDistributionRequest.Builder
to create a request.- Returns:
- Result of the GetTrafficDistribution operation returned by the service.
- See Also:
-
importPhoneNumber
default ImportPhoneNumberResponse importPhoneNumber(ImportPhoneNumberRequest importPhoneNumberRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, IdempotencyException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
- Parameters:
importPhoneNumberRequest
-- Returns:
- Result of the ImportPhoneNumber operation returned by the service.
- See Also:
-
importPhoneNumber
default ImportPhoneNumberResponse importPhoneNumber(Consumer<ImportPhoneNumberRequest.Builder> importPhoneNumberRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, IdempotencyException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
This is a convenience which creates an instance of the
ImportPhoneNumberRequest.Builder
avoiding the need to create one manually viaImportPhoneNumberRequest.builder()
- Parameters:
importPhoneNumberRequest
- AConsumer
that will call methods onImportPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the ImportPhoneNumber operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListAgentStatusesRequest.builder()
- Parameters:
listAgentStatusesRequest
- AConsumer
that will call methods onListAgentStatusesRequest.Builder
to create a request.- Returns:
- Result of the ListAgentStatuses operation returned by the service.
- See Also:
-
listAgentStatusesPaginator
default ListAgentStatusesIterable listAgentStatusesPaginator(ListAgentStatusesRequest listAgentStatusesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listAgentStatusesPaginator
default ListAgentStatusesIterable listAgentStatusesPaginator(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListAgentStatusesIterable responses = client.listAgentStatusesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAgentStatusesRequest.builder()
- Parameters:
listAgentStatusesRequest
- AConsumer
that will call methods onListAgentStatusesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAnalyticsDataAssociations
default ListAnalyticsDataAssociationsResponse listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest) 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 association status of requested dataset ID for a given Amazon Connect instance.
- Parameters:
listAnalyticsDataAssociationsRequest
-- Returns:
- Result of the ListAnalyticsDataAssociations operation returned by the service.
- See Also:
-
listAnalyticsDataAssociations
default ListAnalyticsDataAssociationsResponse listAnalyticsDataAssociations(Consumer<ListAnalyticsDataAssociationsRequest.Builder> listAnalyticsDataAssociationsRequest) 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 association status of requested dataset ID for a given Amazon Connect instance.
This is a convenience which creates an instance of the
ListAnalyticsDataAssociationsRequest.Builder
avoiding the need to create one manually viaListAnalyticsDataAssociationsRequest.builder()
- Parameters:
listAnalyticsDataAssociationsRequest
- AConsumer
that will call methods onListAnalyticsDataAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListAnalyticsDataAssociations operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListApprovedOriginsRequest.builder()
- Parameters:
listApprovedOriginsRequest
- AConsumer
that will call methods onListApprovedOriginsRequest.Builder
to create a request.- Returns:
- Result of the ListApprovedOrigins operation returned by the service.
- See Also:
-
listApprovedOriginsPaginator
default ListApprovedOriginsIterable listApprovedOriginsPaginator(ListApprovedOriginsRequest listApprovedOriginsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listApprovedOriginsPaginator
default ListApprovedOriginsIterable listApprovedOriginsPaginator(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListApprovedOriginsIterable responses = client.listApprovedOriginsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListApprovedOriginsRequest.builder()
- Parameters:
listApprovedOriginsRequest
- AConsumer
that will call methods onListApprovedOriginsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListBotsRequest.builder()
- Parameters:
listBotsRequest
- AConsumer
that will call methods onListBotsRequest.Builder
to create a request.- Returns:
- Result of the ListBots operation returned by the service.
- See Also:
-
listBotsPaginator
default ListBotsIterable listBotsPaginator(ListBotsRequest listBotsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listBotsPaginator
default ListBotsIterable listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListBotsRequest.builder()
- Parameters:
listBotsRequest
- AConsumer
that will call methods onListBotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListContactEvaluationsRequest.builder()
- Parameters:
listContactEvaluationsRequest
- AConsumer
that will call methods onListContactEvaluationsRequest.Builder
to create a request.- Returns:
- Result of the ListContactEvaluations operation returned by the service.
- See Also:
-
listContactEvaluationsPaginator
default ListContactEvaluationsIterable listContactEvaluationsPaginator(ListContactEvaluationsRequest listContactEvaluationsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listContactEvaluationsPaginator
default ListContactEvaluationsIterable listContactEvaluationsPaginator(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactEvaluationsIterable responses = client.listContactEvaluationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListContactEvaluationsRequest.builder()
- Parameters:
listContactEvaluationsRequest
- AConsumer
that will call methods onListContactEvaluationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListContactFlowModulesRequest.builder()
- Parameters:
listContactFlowModulesRequest
- AConsumer
that will call methods onListContactFlowModulesRequest.Builder
to create a request.- Returns:
- Result of the ListContactFlowModules operation returned by the service.
- See Also:
-
listContactFlowModulesPaginator
default ListContactFlowModulesIterable listContactFlowModulesPaginator(ListContactFlowModulesRequest listContactFlowModulesRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listContactFlowModulesPaginator
default ListContactFlowModulesIterable listContactFlowModulesPaginator(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactFlowModulesIterable responses = client.listContactFlowModulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListContactFlowModulesRequest.builder()
- Parameters:
listContactFlowModulesRequest
- AConsumer
that will call methods onListContactFlowModulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListContactFlowsRequest.builder()
- Parameters:
listContactFlowsRequest
- AConsumer
that will call methods onListContactFlowsRequest.Builder
to create a request.- Returns:
- Result of the ListContactFlows operation returned by the service.
- See Also:
-
listContactFlowsPaginator
default ListContactFlowsIterable listContactFlowsPaginator(ListContactFlowsRequest listContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listContactFlowsPaginator
default ListContactFlowsIterable listContactFlowsPaginator(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactFlowsIterable responses = client.listContactFlowsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListContactFlowsRequest.builder()
- Parameters:
listContactFlowsRequest
- AConsumer
that will call methods onListContactFlowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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. References are links to documents that are related to a contact, such as emails, attachments, or URLs.- Parameters:
listContactReferencesRequest
-- Returns:
- Result of the ListContactReferences operation returned by the service.
- See Also:
-
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. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
This is a convenience which creates an instance of the
ListContactReferencesRequest.Builder
avoiding the need to create one manually viaListContactReferencesRequest.builder()
- Parameters:
listContactReferencesRequest
- AConsumer
that will call methods onListContactReferencesRequest.Builder
to create a request.- Returns:
- Result of the ListContactReferences operation returned by the service.
- See Also:
-
listContactReferencesPaginator
default ListContactReferencesIterable listContactReferencesPaginator(ListContactReferencesRequest listContactReferencesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listContactReferencesPaginator
default ListContactReferencesIterable listContactReferencesPaginator(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListContactReferencesIterable responses = client.listContactReferencesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListContactReferencesRequest.builder()
- Parameters:
listContactReferencesRequest
- AConsumer
that will call methods onListContactReferencesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListDefaultVocabulariesRequest.builder()
- Parameters:
listDefaultVocabulariesRequest
- AConsumer
that will call methods onListDefaultVocabulariesRequest.Builder
to create a request.- Returns:
- Result of the ListDefaultVocabularies operation returned by the service.
- See Also:
-
listDefaultVocabulariesPaginator
default ListDefaultVocabulariesIterable listDefaultVocabulariesPaginator(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listDefaultVocabulariesPaginator
default ListDefaultVocabulariesIterable listDefaultVocabulariesPaginator(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesIterable responses = client.listDefaultVocabulariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDefaultVocabulariesRequest.builder()
- Parameters:
listDefaultVocabulariesRequest
- AConsumer
that will call methods onListDefaultVocabulariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListEvaluationFormVersionsRequest.builder()
- Parameters:
listEvaluationFormVersionsRequest
- AConsumer
that will call methods onListEvaluationFormVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListEvaluationFormVersions operation returned by the service.
- See Also:
-
listEvaluationFormVersionsPaginator
default ListEvaluationFormVersionsIterable listEvaluationFormVersionsPaginator(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listEvaluationFormVersionsPaginator
default ListEvaluationFormVersionsIterable listEvaluationFormVersionsPaginator(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsIterable responses = client.listEvaluationFormVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEvaluationFormVersionsRequest.builder()
- Parameters:
listEvaluationFormVersionsRequest
- AConsumer
that will call methods onListEvaluationFormVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListEvaluationFormsRequest.builder()
- Parameters:
listEvaluationFormsRequest
- AConsumer
that will call methods onListEvaluationFormsRequest.Builder
to create a request.- Returns:
- Result of the ListEvaluationForms operation returned by the service.
- See Also:
-
listEvaluationFormsPaginator
default ListEvaluationFormsIterable listEvaluationFormsPaginator(ListEvaluationFormsRequest listEvaluationFormsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listEvaluationFormsPaginator
default ListEvaluationFormsIterable listEvaluationFormsPaginator(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListEvaluationFormsIterable responses = client.listEvaluationFormsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEvaluationFormsRequest.builder()
- Parameters:
listEvaluationFormsRequest
- AConsumer
that will call methods onListEvaluationFormsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlowAssociations
default ListFlowAssociationsResponse listFlowAssociations(ListFlowAssociationsRequest listFlowAssociationsRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException List the flow association based on the filters.
- Parameters:
listFlowAssociationsRequest
-- Returns:
- Result of the ListFlowAssociations operation returned by the service.
- See Also:
-
listFlowAssociations
default ListFlowAssociationsResponse listFlowAssociations(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException List the flow association based on the filters.
This is a convenience which creates an instance of the
ListFlowAssociationsRequest.Builder
avoiding the need to create one manually viaListFlowAssociationsRequest.builder()
- Parameters:
listFlowAssociationsRequest
- AConsumer
that will call methods onListFlowAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListFlowAssociations operation returned by the service.
- See Also:
-
listFlowAssociationsPaginator
default ListFlowAssociationsIterable listFlowAssociationsPaginator(ListFlowAssociationsRequest listFlowAssociationsRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client.listFlowAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client .listFlowAssociationsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client.listFlowAssociationsPaginator(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
listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
operation.- Parameters:
listFlowAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlowAssociationsPaginator
default ListFlowAssociationsIterable listFlowAssociationsPaginator(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest) throws AccessDeniedException, ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client.listFlowAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client .listFlowAssociationsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListFlowAssociationsIterable responses = client.listFlowAssociationsPaginator(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
listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListFlowAssociationsRequest.Builder
avoiding the need to create one manually viaListFlowAssociationsRequest.builder()
- Parameters:
listFlowAssociationsRequest
- AConsumer
that will call methods onListFlowAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListHoursOfOperationsRequest.builder()
- Parameters:
listHoursOfOperationsRequest
- AConsumer
that will call methods onListHoursOfOperationsRequest.Builder
to create a request.- Returns:
- Result of the ListHoursOfOperations operation returned by the service.
- See Also:
-
listHoursOfOperationsPaginator
default ListHoursOfOperationsIterable listHoursOfOperationsPaginator(ListHoursOfOperationsRequest listHoursOfOperationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listHoursOfOperationsPaginator
default ListHoursOfOperationsIterable listHoursOfOperationsPaginator(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsIterable responses = client.listHoursOfOperationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListHoursOfOperationsRequest.builder()
- Parameters:
listHoursOfOperationsRequest
- AConsumer
that will call methods onListHoursOfOperationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListInstanceAttributesRequest.builder()
- Parameters:
listInstanceAttributesRequest
- AConsumer
that will call methods onListInstanceAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListInstanceAttributes operation returned by the service.
- See Also:
-
listInstanceAttributesPaginator
default ListInstanceAttributesIterable listInstanceAttributesPaginator(ListInstanceAttributesRequest listInstanceAttributesRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listInstanceAttributesPaginator
default ListInstanceAttributesIterable listInstanceAttributesPaginator(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstanceAttributesIterable responses = client.listInstanceAttributesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListInstanceAttributesRequest.builder()
- Parameters:
listInstanceAttributesRequest
- AConsumer
that will call methods onListInstanceAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListInstanceStorageConfigsRequest.builder()
- Parameters:
listInstanceStorageConfigsRequest
- AConsumer
that will call methods onListInstanceStorageConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListInstanceStorageConfigs operation returned by the service.
- See Also:
-
listInstanceStorageConfigsPaginator
default ListInstanceStorageConfigsIterable listInstanceStorageConfigsPaginator(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listInstanceStorageConfigsPaginator
default ListInstanceStorageConfigsIterable listInstanceStorageConfigsPaginator(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsIterable responses = client.listInstanceStorageConfigsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListInstanceStorageConfigsRequest.builder()
- Parameters:
listInstanceStorageConfigsRequest
- AConsumer
that will call methods onListInstanceStorageConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListInstancesRequest.builder()
- Parameters:
listInstancesRequest
- AConsumer
that will call methods onListInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListInstances operation returned by the service.
- See Also:
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest) throws InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListInstancesRequest.builder()
- Parameters:
listInstancesRequest
- AConsumer
that will call methods onListInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListIntegrationAssociationsRequest.builder()
- Parameters:
listIntegrationAssociationsRequest
- AConsumer
that will call methods onListIntegrationAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListIntegrationAssociations operation returned by the service.
- See Also:
-
listIntegrationAssociationsPaginator
default ListIntegrationAssociationsIterable listIntegrationAssociationsPaginator(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listIntegrationAssociationsPaginator
default ListIntegrationAssociationsIterable listIntegrationAssociationsPaginator(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsIterable responses = client.listIntegrationAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListIntegrationAssociationsRequest.builder()
- Parameters:
listIntegrationAssociationsRequest
- AConsumer
that will call methods onListIntegrationAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListLambdaFunctionsRequest.builder()
- Parameters:
listLambdaFunctionsRequest
- AConsumer
that will call methods onListLambdaFunctionsRequest.Builder
to create a request.- Returns:
- Result of the ListLambdaFunctions operation returned by the service.
- See Also:
-
listLambdaFunctionsPaginator
default ListLambdaFunctionsIterable listLambdaFunctionsPaginator(ListLambdaFunctionsRequest listLambdaFunctionsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listLambdaFunctionsPaginator
default ListLambdaFunctionsIterable listLambdaFunctionsPaginator(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsIterable responses = client.listLambdaFunctionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListLambdaFunctionsRequest.builder()
- Parameters:
listLambdaFunctionsRequest
- AConsumer
that will call methods onListLambdaFunctionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListLexBotsRequest.builder()
- Parameters:
listLexBotsRequest
- AConsumer
that will call methods onListLexBotsRequest.Builder
to create a request.- Returns:
- Result of the ListLexBots operation returned by the service.
- See Also:
-
listLexBotsPaginator
default ListLexBotsIterable listLexBotsPaginator(ListLexBotsRequest listLexBotsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listLexBotsPaginator
default ListLexBotsIterable listLexBotsPaginator(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListLexBotsIterable responses = client.listLexBotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListLexBotsRequest.builder()
- Parameters:
listLexBotsRequest
- AConsumer
that will call methods onListLexBotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
-
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types
UIFN
,SHARED
,THIRD_PARTY_TF
, andTHIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them asTOLL_FREE
orDID
. -
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 aResourceNotFoundException
. 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.
- See Also:
-
-
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.
-
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types
UIFN
,SHARED
,THIRD_PARTY_TF
, andTHIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them asTOLL_FREE
orDID
. -
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 aResourceNotFoundException
. 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 viaListPhoneNumbersRequest.builder()
- Parameters:
listPhoneNumbersRequest
- AConsumer
that will call methods onListPhoneNumbersRequest.Builder
to create a request.- Returns:
- Result of the ListPhoneNumbers operation returned by the service.
- See Also:
-
-
listPhoneNumbersPaginator
default ListPhoneNumbersIterable listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listPhoneNumbersPaginator
default ListPhoneNumbersIterable listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPhoneNumbersRequest.builder()
- Parameters:
listPhoneNumbersRequest
- AConsumer
that will call methods onListPhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
-
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 viaListPhoneNumbersV2Request.builder()
- Parameters:
listPhoneNumbersV2Request
- AConsumer
that will call methods onListPhoneNumbersV2Request.Builder
to create a request.- Returns:
- Result of the ListPhoneNumbersV2 operation returned by the service.
- See Also:
-
-
listPhoneNumbersV2Paginator
default ListPhoneNumbersV2Iterable listPhoneNumbersV2Paginator(ListPhoneNumbersV2Request listPhoneNumbersV2Request) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listPhoneNumbersV2Paginator
default ListPhoneNumbersV2Iterable listPhoneNumbersV2Paginator(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request) throws InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Iterable responses = client.listPhoneNumbersV2Paginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPhoneNumbersV2Request.builder()
- Parameters:
listPhoneNumbersV2Request
- AConsumer
that will call methods onListPhoneNumbersV2Request.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredefinedAttributes
default ListPredefinedAttributesResponse listPredefinedAttributes(ListPredefinedAttributesRequest listPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Lists predefined attributes for the specified Amazon Connect instance.
- Parameters:
listPredefinedAttributesRequest
-- Returns:
- Result of the ListPredefinedAttributes operation returned by the service.
- See Also:
-
listPredefinedAttributes
default ListPredefinedAttributesResponse listPredefinedAttributes(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Lists predefined attributes for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
ListPredefinedAttributesRequest.Builder
avoiding the need to create one manually viaListPredefinedAttributesRequest.builder()
- Parameters:
listPredefinedAttributesRequest
- AConsumer
that will call methods onListPredefinedAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListPredefinedAttributes operation returned by the service.
- See Also:
-
listPredefinedAttributesPaginator
default ListPredefinedAttributesIterable listPredefinedAttributesPaginator(ListPredefinedAttributesRequest listPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client.listPredefinedAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client .listPredefinedAttributesPaginator(request); for (software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client.listPredefinedAttributesPaginator(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
listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
operation.- Parameters:
listPredefinedAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredefinedAttributesPaginator
default ListPredefinedAttributesIterable listPredefinedAttributesPaginator(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client.listPredefinedAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client .listPredefinedAttributesPaginator(request); for (software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesIterable responses = client.listPredefinedAttributesPaginator(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
listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest)
operation.
This is a convenience which creates an instance of the
ListPredefinedAttributesRequest.Builder
avoiding the need to create one manually viaListPredefinedAttributesRequest.builder()
- Parameters:
listPredefinedAttributesRequest
- AConsumer
that will call methods onListPredefinedAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListPromptsRequest.builder()
- Parameters:
listPromptsRequest
- AConsumer
that will call methods onListPromptsRequest.Builder
to create a request.- Returns:
- Result of the ListPrompts operation returned by the service.
- See Also:
-
listPromptsPaginator
default ListPromptsIterable listPromptsPaginator(ListPromptsRequest listPromptsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listPromptsPaginator
default ListPromptsIterable listPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPromptsRequest.builder()
- Parameters:
listPromptsRequest
- AConsumer
that will call methods onListPromptsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListQueueQuickConnectsRequest.builder()
- Parameters:
listQueueQuickConnectsRequest
- AConsumer
that will call methods onListQueueQuickConnectsRequest.Builder
to create a request.- Returns:
- Result of the ListQueueQuickConnects operation returned by the service.
- See Also:
-
listQueueQuickConnectsPaginator
default ListQueueQuickConnectsIterable listQueueQuickConnectsPaginator(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listQueueQuickConnectsPaginator
default ListQueueQuickConnectsIterable listQueueQuickConnectsPaginator(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsIterable responses = client.listQueueQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListQueueQuickConnectsRequest.builder()
- Parameters:
listQueueQuickConnectsRequest
- AConsumer
that will call methods onListQueueQuickConnectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListQueuesRequest.builder()
- Parameters:
listQueuesRequest
- AConsumer
that will call methods onListQueuesRequest.Builder
to create a request.- Returns:
- Result of the ListQueues operation returned by the service.
- See Also:
-
listQueuesPaginator
default ListQueuesIterable listQueuesPaginator(ListQueuesRequest listQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listQueuesPaginator
default ListQueuesIterable listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListQueuesRequest.builder()
- Parameters:
listQueuesRequest
- AConsumer
that will call methods onListQueuesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListQuickConnectsRequest.builder()
- Parameters:
listQuickConnectsRequest
- AConsumer
that will call methods onListQuickConnectsRequest.Builder
to create a request.- Returns:
- Result of the ListQuickConnects operation returned by the service.
- See Also:
-
listQuickConnectsPaginator
default ListQuickConnectsIterable listQuickConnectsPaginator(ListQuickConnectsRequest listQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listQuickConnectsPaginator
default ListQuickConnectsIterable listQuickConnectsPaginator(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListQuickConnectsIterable responses = client.listQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListQuickConnectsRequest.builder()
- Parameters:
listQuickConnectsRequest
- AConsumer
that will call methods onListQuickConnectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRealtimeContactAnalysisSegmentsV2
default ListRealtimeContactAnalysisSegmentsV2Response listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request) throws OutputTypeNotFoundException, AccessDeniedException, ResourceNotFoundException, InvalidRequestException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Provides a list of analysis segments for a real-time analysis session.
- Parameters:
listRealtimeContactAnalysisSegmentsV2Request
-- Returns:
- Result of the ListRealtimeContactAnalysisSegmentsV2 operation returned by the service.
- See Also:
-
listRealtimeContactAnalysisSegmentsV2
default ListRealtimeContactAnalysisSegmentsV2Response listRealtimeContactAnalysisSegmentsV2(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request) throws OutputTypeNotFoundException, AccessDeniedException, ResourceNotFoundException, InvalidRequestException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Provides a list of analysis segments for a real-time analysis session.
This is a convenience which creates an instance of the
ListRealtimeContactAnalysisSegmentsV2Request.Builder
avoiding the need to create one manually viaListRealtimeContactAnalysisSegmentsV2Request.builder()
- Parameters:
listRealtimeContactAnalysisSegmentsV2Request
- AConsumer
that will call methods onListRealtimeContactAnalysisSegmentsV2Request.Builder
to create a request.- Returns:
- Result of the ListRealtimeContactAnalysisSegmentsV2 operation returned by the service.
- See Also:
-
listRealtimeContactAnalysisSegmentsV2Paginator
default ListRealtimeContactAnalysisSegmentsV2Iterable listRealtimeContactAnalysisSegmentsV2Paginator(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request) throws OutputTypeNotFoundException, AccessDeniedException, ResourceNotFoundException, InvalidRequestException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client.listRealtimeContactAnalysisSegmentsV2Paginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client .listRealtimeContactAnalysisSegmentsV2Paginator(request); for (software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client.listRealtimeContactAnalysisSegmentsV2Paginator(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
listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request)
operation.- Parameters:
listRealtimeContactAnalysisSegmentsV2Request
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRealtimeContactAnalysisSegmentsV2Paginator
default ListRealtimeContactAnalysisSegmentsV2Iterable listRealtimeContactAnalysisSegmentsV2Paginator(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request) throws OutputTypeNotFoundException, AccessDeniedException, ResourceNotFoundException, InvalidRequestException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client.listRealtimeContactAnalysisSegmentsV2Paginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client .listRealtimeContactAnalysisSegmentsV2Paginator(request); for (software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Iterable responses = client.listRealtimeContactAnalysisSegmentsV2Paginator(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
listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request)
operation.
This is a convenience which creates an instance of the
ListRealtimeContactAnalysisSegmentsV2Request.Builder
avoiding the need to create one manually viaListRealtimeContactAnalysisSegmentsV2Request.builder()
- Parameters:
listRealtimeContactAnalysisSegmentsV2Request
- AConsumer
that will call methods onListRealtimeContactAnalysisSegmentsV2Request.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListRoutingProfileQueuesRequest.builder()
- Parameters:
listRoutingProfileQueuesRequest
- AConsumer
that will call methods onListRoutingProfileQueuesRequest.Builder
to create a request.- Returns:
- Result of the ListRoutingProfileQueues operation returned by the service.
- See Also:
-
listRoutingProfileQueuesPaginator
default ListRoutingProfileQueuesIterable listRoutingProfileQueuesPaginator(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listRoutingProfileQueuesPaginator
default ListRoutingProfileQueuesIterable listRoutingProfileQueuesPaginator(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesIterable responses = client.listRoutingProfileQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListRoutingProfileQueuesRequest.builder()
- Parameters:
listRoutingProfileQueuesRequest
- AConsumer
that will call methods onListRoutingProfileQueuesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListRoutingProfilesRequest.builder()
- Parameters:
listRoutingProfilesRequest
- AConsumer
that will call methods onListRoutingProfilesRequest.Builder
to create a request.- Returns:
- Result of the ListRoutingProfiles operation returned by the service.
- See Also:
-
listRoutingProfilesPaginator
default ListRoutingProfilesIterable listRoutingProfilesPaginator(ListRoutingProfilesRequest listRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listRoutingProfilesPaginator
default ListRoutingProfilesIterable listRoutingProfilesPaginator(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRoutingProfilesIterable responses = client.listRoutingProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListRoutingProfilesRequest.builder()
- Parameters:
listRoutingProfilesRequest
- AConsumer
that will call methods onListRoutingProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.Builder
to create a request.- Returns:
- Result of the ListRules operation returned by the service.
- See Also:
-
listRulesPaginator
default ListRulesIterable listRulesPaginator(ListRulesRequest listRulesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listRulesPaginator
default ListRulesIterable listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListRulesIterable responses = client.listRulesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListSecurityKeysRequest.builder()
- Parameters:
listSecurityKeysRequest
- AConsumer
that will call methods onListSecurityKeysRequest.Builder
to create a request.- Returns:
- Result of the ListSecurityKeys operation returned by the service.
- See Also:
-
listSecurityKeysPaginator
default ListSecurityKeysIterable listSecurityKeysPaginator(ListSecurityKeysRequest listSecurityKeysRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listSecurityKeysPaginator
default ListSecurityKeysIterable listSecurityKeysPaginator(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityKeysIterable responses = client.listSecurityKeysPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSecurityKeysRequest.builder()
- Parameters:
listSecurityKeysRequest
- AConsumer
that will call methods onListSecurityKeysRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityProfileApplications
default ListSecurityProfileApplicationsResponse listSecurityProfileApplications(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Returns a list of third-party applications in a specific security profile.
- Parameters:
listSecurityProfileApplicationsRequest
-- Returns:
- Result of the ListSecurityProfileApplications operation returned by the service.
- See Also:
-
listSecurityProfileApplications
default ListSecurityProfileApplicationsResponse listSecurityProfileApplications(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Returns a list of third-party applications in a specific security profile.
This is a convenience which creates an instance of the
ListSecurityProfileApplicationsRequest.Builder
avoiding the need to create one manually viaListSecurityProfileApplicationsRequest.builder()
- Parameters:
listSecurityProfileApplicationsRequest
- AConsumer
that will call methods onListSecurityProfileApplicationsRequest.Builder
to create a request.- Returns:
- Result of the ListSecurityProfileApplications operation returned by the service.
- See Also:
-
listSecurityProfileApplicationsPaginator
default ListSecurityProfileApplicationsIterable listSecurityProfileApplicationsPaginator(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client.listSecurityProfileApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client .listSecurityProfileApplicationsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client.listSecurityProfileApplicationsPaginator(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
listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
operation.- Parameters:
listSecurityProfileApplicationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityProfileApplicationsPaginator
default ListSecurityProfileApplicationsIterable listSecurityProfileApplicationsPaginator(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client.listSecurityProfileApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client .listSecurityProfileApplicationsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsIterable responses = client.listSecurityProfileApplicationsPaginator(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
listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListSecurityProfileApplicationsRequest.Builder
avoiding the need to create one manually viaListSecurityProfileApplicationsRequest.builder()
- Parameters:
listSecurityProfileApplicationsRequest
- AConsumer
that will call methods onListSecurityProfileApplicationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityProfilePermissions
default ListSecurityProfilePermissionsResponse listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Lists the permissions granted to a security profile.
- Parameters:
listSecurityProfilePermissionsRequest
-- Returns:
- Result of the ListSecurityProfilePermissions operation returned by the service.
- See Also:
-
listSecurityProfilePermissions
default ListSecurityProfilePermissionsResponse listSecurityProfilePermissions(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 viaListSecurityProfilePermissionsRequest.builder()
- Parameters:
listSecurityProfilePermissionsRequest
- AConsumer
that will call methods onListSecurityProfilePermissionsRequest.Builder
to create a request.- Returns:
- Result of the ListSecurityProfilePermissions operation returned by the service.
- See Also:
-
listSecurityProfilePermissionsPaginator
default ListSecurityProfilePermissionsIterable listSecurityProfilePermissionsPaginator(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listSecurityProfilePermissionsPaginator
default ListSecurityProfilePermissionsIterable listSecurityProfilePermissionsPaginator(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsIterable responses = client.listSecurityProfilePermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSecurityProfilePermissionsRequest.builder()
- Parameters:
listSecurityProfilePermissionsRequest
- AConsumer
that will call methods onListSecurityProfilePermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListSecurityProfilesRequest.builder()
- Parameters:
listSecurityProfilesRequest
- AConsumer
that will call methods onListSecurityProfilesRequest.Builder
to create a request.- Returns:
- Result of the ListSecurityProfiles operation returned by the service.
- See Also:
-
listSecurityProfilesPaginator
default ListSecurityProfilesIterable listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listSecurityProfilesPaginator
default ListSecurityProfilesIterable listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSecurityProfilesRequest.builder()
- Parameters:
listSecurityProfilesRequest
- AConsumer
that will call methods onListSecurityProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListTaskTemplatesRequest.builder()
- Parameters:
listTaskTemplatesRequest
- AConsumer
that will call methods onListTaskTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListTaskTemplates operation returned by the service.
- See Also:
-
listTaskTemplatesPaginator
default ListTaskTemplatesIterable listTaskTemplatesPaginator(ListTaskTemplatesRequest listTaskTemplatesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listTaskTemplatesPaginator
default ListTaskTemplatesIterable listTaskTemplatesPaginator(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTaskTemplatesIterable responses = client.listTaskTemplatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTaskTemplatesRequest.builder()
- Parameters:
listTaskTemplatesRequest
- AConsumer
that will call methods onListTaskTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListTrafficDistributionGroupUsersRequest.builder()
- Parameters:
listTrafficDistributionGroupUsersRequest
- AConsumer
that will call methods onListTrafficDistributionGroupUsersRequest.Builder
to create a request.- Returns:
- Result of the ListTrafficDistributionGroupUsers operation returned by the service.
- See Also:
-
listTrafficDistributionGroupUsersPaginator
default ListTrafficDistributionGroupUsersIterable listTrafficDistributionGroupUsersPaginator(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest) throws ResourceNotFoundException, InvalidRequestException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listTrafficDistributionGroupUsersPaginator
default ListTrafficDistributionGroupUsersIterable listTrafficDistributionGroupUsersPaginator(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest) throws ResourceNotFoundException, InvalidRequestException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersIterable responses = client.listTrafficDistributionGroupUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTrafficDistributionGroupUsersRequest.builder()
- Parameters:
listTrafficDistributionGroupUsersRequest
- AConsumer
that will call methods onListTrafficDistributionGroupUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListTrafficDistributionGroupsRequest.builder()
- Parameters:
listTrafficDistributionGroupsRequest
- AConsumer
that will call methods onListTrafficDistributionGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListTrafficDistributionGroups operation returned by the service.
- See Also:
-
listTrafficDistributionGroupsPaginator
default ListTrafficDistributionGroupsIterable listTrafficDistributionGroupsPaginator(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest) throws InvalidRequestException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listTrafficDistributionGroupsPaginator
default ListTrafficDistributionGroupsIterable listTrafficDistributionGroupsPaginator(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest) throws InvalidRequestException, AccessDeniedException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsIterable responses = client.listTrafficDistributionGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTrafficDistributionGroupsRequest.builder()
- Parameters:
listTrafficDistributionGroupsRequest
- AConsumer
that will call methods onListTrafficDistributionGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListUseCasesRequest.builder()
- Parameters:
listUseCasesRequest
- AConsumer
that will call methods onListUseCasesRequest.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.
- See Also:
-
listUseCasesPaginator
default ListUseCasesIterable listUseCasesPaginator(ListUseCasesRequest listUseCasesRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listUseCasesPaginator
default ListUseCasesIterable listUseCasesPaginator(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest) throws ResourceNotFoundException, InternalServiceException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUseCasesIterable responses = client.listUseCasesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUseCasesRequest.builder()
- Parameters:
listUseCasesRequest
- AConsumer
that will call methods onListUseCasesRequest.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.
- See Also:
-
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.
- See Also:
-
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 viaListUserHierarchyGroupsRequest.builder()
- Parameters:
listUserHierarchyGroupsRequest
- AConsumer
that will call methods onListUserHierarchyGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListUserHierarchyGroups operation returned by the service.
- See Also:
-
listUserHierarchyGroupsPaginator
default ListUserHierarchyGroupsIterable listUserHierarchyGroupsPaginator(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listUserHierarchyGroupsPaginator
default ListUserHierarchyGroupsIterable listUserHierarchyGroupsPaginator(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsIterable responses = client.listUserHierarchyGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUserHierarchyGroupsRequest.builder()
- Parameters:
listUserHierarchyGroupsRequest
- AConsumer
that will call methods onListUserHierarchyGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUserProficiencies
default ListUserProficienciesResponse listUserProficiencies(ListUserProficienciesRequest listUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Lists proficiencies associated with a user.
- Parameters:
listUserProficienciesRequest
-- Returns:
- Result of the ListUserProficiencies operation returned by the service.
- See Also:
-
listUserProficiencies
default ListUserProficienciesResponse listUserProficiencies(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Lists proficiencies associated with a user.
This is a convenience which creates an instance of the
ListUserProficienciesRequest.Builder
avoiding the need to create one manually viaListUserProficienciesRequest.builder()
- Parameters:
listUserProficienciesRequest
- AConsumer
that will call methods onListUserProficienciesRequest.Builder
to create a request.- Returns:
- Result of the ListUserProficiencies operation returned by the service.
- See Also:
-
listUserProficienciesPaginator
default ListUserProficienciesIterable listUserProficienciesPaginator(ListUserProficienciesRequest listUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client.listUserProficienciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client .listUserProficienciesPaginator(request); for (software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client.listUserProficienciesPaginator(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
listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
operation.- Parameters:
listUserProficienciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUserProficienciesPaginator
default ListUserProficienciesIterable listUserProficienciesPaginator(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client.listUserProficienciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client .listUserProficienciesPaginator(request); for (software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListUserProficienciesIterable responses = client.listUserProficienciesPaginator(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
listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest)
operation.
This is a convenience which creates an instance of the
ListUserProficienciesRequest.Builder
avoiding the need to create one manually viaListUserProficienciesRequest.builder()
- Parameters:
listUserProficienciesRequest
- AConsumer
that will call methods onListUserProficienciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listViewVersions
default ListViewVersionsResponse listViewVersions(ListViewVersionsRequest listViewVersionsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
- Parameters:
listViewVersionsRequest
-- Returns:
- Result of the ListViewVersions operation returned by the service.
- See Also:
-
listViewVersions
default ListViewVersionsResponse listViewVersions(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
This is a convenience which creates an instance of the
ListViewVersionsRequest.Builder
avoiding the need to create one manually viaListViewVersionsRequest.builder()
- Parameters:
listViewVersionsRequest
- AConsumer
that will call methods onListViewVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListViewVersions operation returned by the service.
- See Also:
-
listViewVersionsPaginator
default ListViewVersionsIterable listViewVersionsPaginator(ListViewVersionsRequest listViewVersionsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client.listViewVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client .listViewVersionsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListViewVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client.listViewVersionsPaginator(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
listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
operation.- Parameters:
listViewVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listViewVersionsPaginator
default ListViewVersionsIterable listViewVersionsPaginator(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client.listViewVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client .listViewVersionsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListViewVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListViewVersionsIterable responses = client.listViewVersionsPaginator(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
listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListViewVersionsRequest.Builder
avoiding the need to create one manually viaListViewVersionsRequest.builder()
- Parameters:
listViewVersionsRequest
- AConsumer
that will call methods onListViewVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listViews
default ListViewsResponse listViews(ListViewsRequest listViewsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
- Parameters:
listViewsRequest
-- Returns:
- Result of the ListViews operation returned by the service.
- See Also:
-
listViews
default ListViewsResponse listViews(Consumer<ListViewsRequest.Builder> listViewsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
This is a convenience which creates an instance of the
ListViewsRequest.Builder
avoiding the need to create one manually viaListViewsRequest.builder()
- Parameters:
listViewsRequest
- AConsumer
that will call methods onListViewsRequest.Builder
to create a request.- Returns:
- Result of the ListViews operation returned by the service.
- See Also:
-
listViewsPaginator
default ListViewsIterable listViewsPaginator(ListViewsRequest listViewsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(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
listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
operation.- Parameters:
listViewsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listViewsPaginator
default ListViewsIterable listViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, AwsServiceException, SdkClientException, ConnectException This is a variant of
listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(request); for (software.amazon.awssdk.services.connect.model.ListViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.ListViewsIterable responses = client.listViewsPaginator(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
listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest)
operation.
This is a convenience which creates an instance of the
ListViewsRequest.Builder
avoiding the need to create one manually viaListViewsRequest.builder()
- Parameters:
listViewsRequest
- AConsumer
that will call methods onListViewsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaMonitorContactRequest.builder()
- Parameters:
monitorContactRequest
- AConsumer
that will call methods onMonitorContactRequest.Builder
to create a request.- Returns:
- Result of the MonitorContact operation returned by the service.
- See Also:
-
pauseContact
default PauseContactResponse pauseContact(PauseContactRequest pauseContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, ConnectException Allows pausing an ongoing task contact.
- Parameters:
pauseContactRequest
-- Returns:
- Result of the PauseContact operation returned by the service.
- See Also:
-
pauseContact
default PauseContactResponse pauseContact(Consumer<PauseContactRequest.Builder> pauseContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, ConnectException Allows pausing an ongoing task contact.
This is a convenience which creates an instance of the
PauseContactRequest.Builder
avoiding the need to create one manually viaPauseContactRequest.builder()
- Parameters:
pauseContactRequest
- AConsumer
that will call methods onPauseContactRequest.Builder
to create a request.- Returns:
- Result of the PauseContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaPutUserStatusRequest.builder()
- Parameters:
putUserStatusRequest
- AConsumer
that will call methods onPutUserStatusRequest.Builder
to create a request.- Returns:
- Result of the PutUserStatus operation returned by the service.
- See Also:
-
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 admin website.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.
- See Also:
-
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 admin website.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 viaReleasePhoneNumberRequest.builder()
- Parameters:
releasePhoneNumberRequest
- AConsumer
that will call methods onReleasePhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the ReleasePhoneNumber operation returned by the service.
- See Also:
-
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 and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
- Parameters:
replicateInstanceRequest
-- Returns:
- Result of the ReplicateInstance operation returned by the service.
- See Also:
-
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 and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
ReplicateInstanceRequest.Builder
avoiding the need to create one manually viaReplicateInstanceRequest.builder()
- Parameters:
replicateInstanceRequest
- AConsumer
that will call methods onReplicateInstanceRequest.Builder
to create a request.- Returns:
- Result of the ReplicateInstance operation returned by the service.
- See Also:
-
resumeContact
default ResumeContactResponse resumeContact(ResumeContactRequest resumeContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, ConnectException Allows resuming a task contact in a paused state.
- Parameters:
resumeContactRequest
-- Returns:
- Result of the ResumeContact operation returned by the service.
- See Also:
-
resumeContact
default ResumeContactResponse resumeContact(Consumer<ResumeContactRequest.Builder> resumeContactRequest) throws AccessDeniedException, InternalServiceException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, ConnectException Allows resuming a task contact in a paused state.
This is a convenience which creates an instance of the
ResumeContactRequest.Builder
avoiding the need to create one manually viaResumeContactRequest.builder()
- Parameters:
resumeContactRequest
- AConsumer
that will call methods onResumeContactRequest.Builder
to create a request.- Returns:
- Result of the ResumeContact operation returned by the service.
- See Also:
-
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 whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
- Parameters:
resumeContactRecordingRequest
-- Returns:
- Result of the ResumeContactRecording operation returned by the service.
- See Also:
-
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 whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
This is a convenience which creates an instance of the
ResumeContactRecordingRequest.Builder
avoiding the need to create one manually viaResumeContactRecordingRequest.builder()
- Parameters:
resumeContactRecordingRequest
- AConsumer
that will call methods onResumeContactRecordingRequest.Builder
to create a request.- Returns:
- Result of the ResumeContactRecording operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaSearchAvailablePhoneNumbersRequest.builder()
- Parameters:
searchAvailablePhoneNumbersRequest
- AConsumer
that will call methods onSearchAvailablePhoneNumbersRequest.Builder
to create a request.- Returns:
- Result of the SearchAvailablePhoneNumbers operation returned by the service.
- See Also:
-
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws InvalidParameterException, ThrottlingException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) throws InvalidParameterException, ThrottlingException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchAvailablePhoneNumbersRequest.builder()
- Parameters:
searchAvailablePhoneNumbersRequest
- AConsumer
that will call methods onSearchAvailablePhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContactFlowModules
default SearchContactFlowModulesResponse searchContactFlowModules(SearchContactFlowModulesRequest searchContactFlowModulesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Searches the flow modules in an Amazon Connect instance, with optional filtering.
- Parameters:
searchContactFlowModulesRequest
-- Returns:
- Result of the SearchContactFlowModules operation returned by the service.
- See Also:
-
searchContactFlowModules
default SearchContactFlowModulesResponse searchContactFlowModules(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Searches the flow modules in an Amazon Connect instance, with optional filtering.
This is a convenience which creates an instance of the
SearchContactFlowModulesRequest.Builder
avoiding the need to create one manually viaSearchContactFlowModulesRequest.builder()
- Parameters:
searchContactFlowModulesRequest
- AConsumer
that will call methods onSearchContactFlowModulesRequest.Builder
to create a request.- Returns:
- Result of the SearchContactFlowModules operation returned by the service.
- See Also:
-
searchContactFlowModulesPaginator
default SearchContactFlowModulesIterable searchContactFlowModulesPaginator(SearchContactFlowModulesRequest searchContactFlowModulesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client.searchContactFlowModulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client .searchContactFlowModulesPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client.searchContactFlowModulesPaginator(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
searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
operation.- Parameters:
searchContactFlowModulesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContactFlowModulesPaginator
default SearchContactFlowModulesIterable searchContactFlowModulesPaginator(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client.searchContactFlowModulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client .searchContactFlowModulesPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesIterable responses = client.searchContactFlowModulesPaginator(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
searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest)
operation.
This is a convenience which creates an instance of the
SearchContactFlowModulesRequest.Builder
avoiding the need to create one manually viaSearchContactFlowModulesRequest.builder()
- Parameters:
searchContactFlowModulesRequest
- AConsumer
that will call methods onSearchContactFlowModulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContactFlows
default SearchContactFlowsResponse searchContactFlows(SearchContactFlowsRequest searchContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Searches the contact flows in an Amazon Connect instance, with optional filtering.
- Parameters:
searchContactFlowsRequest
-- Returns:
- Result of the SearchContactFlows operation returned by the service.
- See Also:
-
searchContactFlows
default SearchContactFlowsResponse searchContactFlows(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Searches the contact flows in an Amazon Connect instance, with optional filtering.
This is a convenience which creates an instance of the
SearchContactFlowsRequest.Builder
avoiding the need to create one manually viaSearchContactFlowsRequest.builder()
- Parameters:
searchContactFlowsRequest
- AConsumer
that will call methods onSearchContactFlowsRequest.Builder
to create a request.- Returns:
- Result of the SearchContactFlows operation returned by the service.
- See Also:
-
searchContactFlowsPaginator
default SearchContactFlowsIterable searchContactFlowsPaginator(SearchContactFlowsRequest searchContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client.searchContactFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client .searchContactFlowsPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client.searchContactFlowsPaginator(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
searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
operation.- Parameters:
searchContactFlowsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContactFlowsPaginator
default SearchContactFlowsIterable searchContactFlowsPaginator(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client.searchContactFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client .searchContactFlowsPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactFlowsIterable responses = client.searchContactFlowsPaginator(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
searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest)
operation.
This is a convenience which creates an instance of the
SearchContactFlowsRequest.Builder
avoiding the need to create one manually viaSearchContactFlowsRequest.builder()
- Parameters:
searchContactFlowsRequest
- AConsumer
that will call methods onSearchContactFlowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContacts
default SearchContactsResponse searchContacts(SearchContactsRequest searchContactsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Searches contacts in an Amazon Connect instance.
- Parameters:
searchContactsRequest
-- Returns:
- Result of the SearchContacts operation returned by the service.
- See Also:
-
searchContacts
default SearchContactsResponse searchContacts(Consumer<SearchContactsRequest.Builder> searchContactsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Searches contacts in an Amazon Connect instance.
This is a convenience which creates an instance of the
SearchContactsRequest.Builder
avoiding the need to create one manually viaSearchContactsRequest.builder()
- Parameters:
searchContactsRequest
- AConsumer
that will call methods onSearchContactsRequest.Builder
to create a request.- Returns:
- Result of the SearchContacts operation returned by the service.
- See Also:
-
searchContactsPaginator
default SearchContactsIterable searchContactsPaginator(SearchContactsRequest searchContactsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(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
searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
operation.- Parameters:
searchContactsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContactsPaginator
default SearchContactsIterable searchContactsPaginator(Consumer<SearchContactsRequest.Builder> searchContactsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchContactsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchContactsIterable responses = client.searchContactsPaginator(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
searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest)
operation.
This is a convenience which creates an instance of the
SearchContactsRequest.Builder
avoiding the need to create one manually viaSearchContactsRequest.builder()
- Parameters:
searchContactsRequest
- AConsumer
that will call methods onSearchContactsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchHoursOfOperationsRequest.builder()
- Parameters:
searchHoursOfOperationsRequest
- AConsumer
that will call methods onSearchHoursOfOperationsRequest.Builder
to create a request.- Returns:
- Result of the SearchHoursOfOperations operation returned by the service.
- See Also:
-
searchHoursOfOperationsPaginator
default SearchHoursOfOperationsIterable searchHoursOfOperationsPaginator(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchHoursOfOperationsPaginator
default SearchHoursOfOperationsIterable searchHoursOfOperationsPaginator(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsIterable responses = client.searchHoursOfOperationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchHoursOfOperationsRequest.builder()
- Parameters:
searchHoursOfOperationsRequest
- AConsumer
that will call methods onSearchHoursOfOperationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchPredefinedAttributes
default SearchPredefinedAttributesResponse searchPredefinedAttributes(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Predefined attributes that meet certain criteria.
- Parameters:
searchPredefinedAttributesRequest
-- Returns:
- Result of the SearchPredefinedAttributes operation returned by the service.
- See Also:
-
searchPredefinedAttributes
default SearchPredefinedAttributesResponse searchPredefinedAttributes(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Predefined attributes that meet certain criteria.
This is a convenience which creates an instance of the
SearchPredefinedAttributesRequest.Builder
avoiding the need to create one manually viaSearchPredefinedAttributesRequest.builder()
- Parameters:
searchPredefinedAttributesRequest
- AConsumer
that will call methods onSearchPredefinedAttributesRequest.Builder
to create a request.- Returns:
- Result of the SearchPredefinedAttributes operation returned by the service.
- See Also:
-
searchPredefinedAttributesPaginator
default SearchPredefinedAttributesIterable searchPredefinedAttributesPaginator(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client.searchPredefinedAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client .searchPredefinedAttributesPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client.searchPredefinedAttributesPaginator(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
searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
operation.- Parameters:
searchPredefinedAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchPredefinedAttributesPaginator
default SearchPredefinedAttributesIterable searchPredefinedAttributesPaginator(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException This is a variant of
searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client.searchPredefinedAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client .searchPredefinedAttributesPaginator(request); for (software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesIterable responses = client.searchPredefinedAttributesPaginator(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
searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest)
operation.
This is a convenience which creates an instance of the
SearchPredefinedAttributesRequest.Builder
avoiding the need to create one manually viaSearchPredefinedAttributesRequest.builder()
- Parameters:
searchPredefinedAttributesRequest
- AConsumer
that will call methods onSearchPredefinedAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchPromptsRequest.builder()
- Parameters:
searchPromptsRequest
- AConsumer
that will call methods onSearchPromptsRequest.Builder
to create a request.- Returns:
- Result of the SearchPrompts operation returned by the service.
- See Also:
-
searchPromptsPaginator
default SearchPromptsIterable searchPromptsPaginator(SearchPromptsRequest searchPromptsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchPromptsPaginator
default SearchPromptsIterable searchPromptsPaginator(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchPromptsIterable responses = client.searchPromptsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchPromptsRequest.builder()
- Parameters:
searchPromptsRequest
- AConsumer
that will call methods onSearchPromptsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchQueuesRequest.builder()
- Parameters:
searchQueuesRequest
- AConsumer
that will call methods onSearchQueuesRequest.Builder
to create a request.- Returns:
- Result of the SearchQueues operation returned by the service.
- See Also:
-
searchQueuesPaginator
default SearchQueuesIterable searchQueuesPaginator(SearchQueuesRequest searchQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchQueuesPaginator
default SearchQueuesIterable searchQueuesPaginator(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchQueuesIterable responses = client.searchQueuesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchQueuesRequest.builder()
- Parameters:
searchQueuesRequest
- AConsumer
that will call methods onSearchQueuesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchQuickConnectsRequest.builder()
- Parameters:
searchQuickConnectsRequest
- AConsumer
that will call methods onSearchQuickConnectsRequest.Builder
to create a request.- Returns:
- Result of the SearchQuickConnects operation returned by the service.
- See Also:
-
searchQuickConnectsPaginator
default SearchQuickConnectsIterable searchQuickConnectsPaginator(SearchQuickConnectsRequest searchQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchQuickConnectsPaginator
default SearchQuickConnectsIterable searchQuickConnectsPaginator(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchQuickConnectsIterable responses = client.searchQuickConnectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchQuickConnectsRequest.builder()
- Parameters:
searchQuickConnectsRequest
- AConsumer
that will call methods onSearchQuickConnectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchResourceTagsRequest.builder()
- Parameters:
searchResourceTagsRequest
- AConsumer
that will call methods onSearchResourceTagsRequest.Builder
to create a request.- Returns:
- Result of the SearchResourceTags operation returned by the service.
- See Also:
-
searchResourceTagsPaginator
default SearchResourceTagsIterable searchResourceTagsPaginator(SearchResourceTagsRequest searchResourceTagsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, MaximumResultReturnedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchResourceTagsPaginator
default SearchResourceTagsIterable searchResourceTagsPaginator(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, MaximumResultReturnedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchResourceTagsIterable responses = client.searchResourceTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchResourceTagsRequest.builder()
- Parameters:
searchResourceTagsRequest
- AConsumer
that will call methods onSearchResourceTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchRoutingProfilesRequest.builder()
- Parameters:
searchRoutingProfilesRequest
- AConsumer
that will call methods onSearchRoutingProfilesRequest.Builder
to create a request.- Returns:
- Result of the SearchRoutingProfiles operation returned by the service.
- See Also:
-
searchRoutingProfilesPaginator
default SearchRoutingProfilesIterable searchRoutingProfilesPaginator(SearchRoutingProfilesRequest searchRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchRoutingProfilesPaginator
default SearchRoutingProfilesIterable searchRoutingProfilesPaginator(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesIterable responses = client.searchRoutingProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchRoutingProfilesRequest.builder()
- Parameters:
searchRoutingProfilesRequest
- AConsumer
that will call methods onSearchRoutingProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchSecurityProfilesRequest.builder()
- Parameters:
searchSecurityProfilesRequest
- AConsumer
that will call methods onSearchSecurityProfilesRequest.Builder
to create a request.- Returns:
- Result of the SearchSecurityProfiles operation returned by the service.
- See Also:
-
searchSecurityProfilesPaginator
default SearchSecurityProfilesIterable searchSecurityProfilesPaginator(SearchSecurityProfilesRequest searchSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchSecurityProfilesPaginator
default SearchSecurityProfilesIterable searchSecurityProfilesPaginator(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesIterable responses = client.searchSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchSecurityProfilesRequest.builder()
- Parameters:
searchSecurityProfilesRequest
- AConsumer
that will call methods onSearchSecurityProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaSearchUsersRequest.builder()
- Parameters:
searchUsersRequest
- AConsumer
that will call methods onSearchUsersRequest.Builder
to create a request.- Returns:
- Result of the SearchUsers operation returned by the service.
- See Also:
-
searchUsersPaginator
default SearchUsersIterable searchUsersPaginator(SearchUsersRequest searchUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchUsersPaginator
default SearchUsersIterable searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchUsersRequest.builder()
- Parameters:
searchUsersRequest
- AConsumer
that will call methods onSearchUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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
, andLanguageCode
.- Parameters:
searchVocabulariesRequest
-- Returns:
- Result of the SearchVocabularies operation returned by the service.
- See Also:
-
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
, andLanguageCode
.
This is a convenience which creates an instance of the
SearchVocabulariesRequest.Builder
avoiding the need to create one manually viaSearchVocabulariesRequest.builder()
- Parameters:
searchVocabulariesRequest
- AConsumer
that will call methods onSearchVocabulariesRequest.Builder
to create a request.- Returns:
- Result of the SearchVocabularies operation returned by the service.
- See Also:
-
searchVocabulariesPaginator
default SearchVocabulariesIterable searchVocabulariesPaginator(SearchVocabulariesRequest searchVocabulariesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
searchVocabulariesPaginator
default SearchVocabulariesIterable searchVocabulariesPaginator(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest) throws InvalidRequestException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException 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 Streamsoftware.amazon.awssdk.services.connect.paginators.SearchVocabulariesIterable responses = client.searchVocabulariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchVocabulariesRequest.builder()
- Parameters:
searchVocabulariesRequest
- AConsumer
that will call methods onSearchVocabulariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
sendChatIntegrationEvent
default SendChatIntegrationEventResponse sendChatIntegrationEvent(SendChatIntegrationEventRequest sendChatIntegrationEventRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
-
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
-
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
- Parameters:
sendChatIntegrationEventRequest
-- Returns:
- Result of the SendChatIntegrationEvent operation returned by the service.
- See Also:
-
-
sendChatIntegrationEvent
default SendChatIntegrationEventResponse sendChatIntegrationEvent(Consumer<SendChatIntegrationEventRequest.Builder> sendChatIntegrationEventRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
-
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
-
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
This is a convenience which creates an instance of the
SendChatIntegrationEventRequest.Builder
avoiding the need to create one manually viaSendChatIntegrationEventRequest.builder()
- Parameters:
sendChatIntegrationEventRequest
- AConsumer
that will call methods onSendChatIntegrationEventRequest.Builder
to create a request.- Returns:
- Result of the SendChatIntegrationEvent operation returned by the service.
- See Also:
-
-
startAttachedFileUpload
default StartAttachedFileUploadResponse startAttachedFileUpload(StartAttachedFileUploadRequest startAttachedFileUploadRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ThrottlingException, ResourceConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectException Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
- Parameters:
startAttachedFileUploadRequest
-- Returns:
- Result of the StartAttachedFileUpload operation returned by the service.
- See Also:
-
startAttachedFileUpload
default StartAttachedFileUploadResponse startAttachedFileUpload(Consumer<StartAttachedFileUploadRequest.Builder> startAttachedFileUploadRequest) throws AccessDeniedException, InvalidRequestException, InternalServiceException, ThrottlingException, ResourceConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ConnectException Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
This is a convenience which creates an instance of the
StartAttachedFileUploadRequest.Builder
avoiding the need to create one manually viaStartAttachedFileUploadRequest.builder()
- Parameters:
startAttachedFileUploadRequest
- AConsumer
that will call methods onStartAttachedFileUploadRequest.Builder
to create a request.- Returns:
- Result of the StartAttachedFileUpload operation returned by the service.
- See Also:
-
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.
- See Also:
-
-
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 viaStartChatContactRequest.builder()
- Parameters:
startChatContactRequest
- AConsumer
that will call methods onStartChatContactRequest.Builder
to create a request.- Returns:
- Result of the StartChatContact operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaStartContactEvaluationRequest.builder()
- Parameters:
startContactEvaluationRequest
- AConsumer
that will call methods onStartContactEvaluationRequest.Builder
to create a request.- Returns:
- Result of the StartContactEvaluation operation returned by the service.
- See Also:
-
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.
- See Also:
-
-
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 viaStartContactRecordingRequest.builder()
- Parameters:
startContactRecordingRequest
- AConsumer
that will call methods onStartContactRecordingRequest.Builder
to create a request.- Returns:
- Result of the StartContactRecording operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaStartContactStreamingRequest.builder()
- Parameters:
startContactStreamingRequest
- AConsumer
that will call methods onStartContactStreamingRequest.Builder
to create a request.- Returns:
- Result of the StartContactStreaming operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaStartOutboundVoiceContactRequest.builder()
- Parameters:
startOutboundVoiceContactRequest
- AConsumer
that will call methods onStartOutboundVoiceContactRequest.Builder
to create a request.- Returns:
- Result of the StartOutboundVoiceContact operation returned by the service.
- See Also:
-
startTaskContact
default StartTaskContactResponse startTaskContact(StartTaskContactRequest startTaskContactRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using
PreviousContactId
andRelatedContactId
input parameters, note the following:-
PreviousContactId
-
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId
will affect every contact in the chain. -
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same
PreviousContactId
.
-
-
RelatedContactId
-
Copies contact attributes from the related task contact to the new contact.
-
Any update on attributes in a new task contact does not update attributes on previous contact.
-
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId
.
-
In addition, when calling StartTaskContact include only one of these parameters:
ContactFlowID
,QuickConnectID
, orTaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only theTaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.A
ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the samePreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.- Parameters:
startTaskContactRequest
-- Returns:
- Result of the StartTaskContact operation returned by the service.
- See Also:
-
-
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 contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using
PreviousContactId
andRelatedContactId
input parameters, note the following:-
PreviousContactId
-
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId
will affect every contact in the chain. -
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same
PreviousContactId
.
-
-
RelatedContactId
-
Copies contact attributes from the related task contact to the new contact.
-
Any update on attributes in a new task contact does not update attributes on previous contact.
-
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId
.
-
In addition, when calling StartTaskContact include only one of these parameters:
ContactFlowID
,QuickConnectID
, orTaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only theTaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.A
ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the samePreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
StartTaskContactRequest.Builder
avoiding the need to create one manually viaStartTaskContactRequest.builder()
- Parameters:
startTaskContactRequest
- AConsumer
that will call methods onStartTaskContactRequest.Builder
to create a request.- Returns:
- Result of the StartTaskContact operation returned by the service.
- See Also:
-
-
startWebRTCContact
default StartWebRtcContactResponse startWebRTCContact(StartWebRtcContactRequest startWebRtcContactRequest) throws InternalServiceException, InvalidRequestException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
- Parameters:
startWebRtcContactRequest
-- Returns:
- Result of the StartWebRTCContact operation returned by the service.
- See Also:
-
startWebRTCContact
default StartWebRtcContactResponse startWebRTCContact(Consumer<StartWebRtcContactRequest.Builder> startWebRtcContactRequest) throws InternalServiceException, InvalidRequestException, InvalidParameterException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ConnectException Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
This is a convenience which creates an instance of the
StartWebRtcContactRequest.Builder
avoiding the need to create one manually viaStartWebRtcContactRequest.builder()
- Parameters:
startWebRtcContactRequest
- AConsumer
that will call methods onStartWebRtcContactRequest.Builder
to create a request.- Returns:
- Result of the StartWebRTCContact operation returned by the service.
- See Also:
-
stopContact
default StopContactResponse stopContact(StopContactRequest stopContactRequest) throws InvalidRequestException, ContactNotFoundException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
-
DISCONNECT
-
TRANSFER
-
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
- Parameters:
stopContactRequest
-- Returns:
- Result of the StopContact operation returned by the service.
- See Also:
-
-
stopContact
default StopContactResponse stopContact(Consumer<StopContactRequest.Builder> stopContactRequest) throws InvalidRequestException, ContactNotFoundException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
-
DISCONNECT
-
TRANSFER
-
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
This is a convenience which creates an instance of the
StopContactRequest.Builder
avoiding the need to create one manually viaStopContactRequest.builder()
- Parameters:
stopContactRequest
- AConsumer
that will call methods onStopContactRequest.Builder
to create a request.- Returns:
- Result of the StopContact operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaStopContactRecordingRequest.builder()
- Parameters:
stopContactRecordingRequest
- AConsumer
that will call methods onStopContactRecordingRequest.Builder
to create a request.- Returns:
- Result of the StopContactRecording operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaStopContactStreamingRequest.builder()
- Parameters:
stopContactStreamingRequest
- AConsumer
that will call methods onStopContactStreamingRequest.Builder
to create a request.- Returns:
- Result of the StopContactStreaming operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaSubmitContactEvaluationRequest.builder()
- Parameters:
submitContactEvaluationRequest
- AConsumer
that will call methods onSubmitContactEvaluationRequest.Builder
to create a request.- Returns:
- Result of the SubmitContactEvaluation operation returned by the service.
- See Also:
-
suspendContactRecording
default SuspendContactRecordingResponse suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
- Parameters:
suspendContactRecordingRequest
-- Returns:
- Result of the SuspendContactRecording operation returned by the service.
- See Also:
-
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 whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
This is a convenience which creates an instance of the
SuspendContactRecordingRequest.Builder
avoiding the need to create one manually viaSuspendContactRecordingRequest.builder()
- Parameters:
suspendContactRecordingRequest
- AConsumer
that will call methods onSuspendContactRecordingRequest.Builder
to create a request.- Returns:
- Result of the SuspendContactRecording operation returned by the service.
- See Also:
-
tagContact
default TagContactResponse tagContact(TagContactRequest tagContactRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
- Parameters:
tagContactRequest
-- Returns:
- Result of the TagContact operation returned by the service.
- See Also:
-
tagContact
default TagContactResponse tagContact(Consumer<TagContactRequest.Builder> tagContactRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
This is a convenience which creates an instance of the
TagContactRequest.Builder
avoiding the need to create one manually viaTagContactRequest.builder()
- Parameters:
tagContactRequest
- AConsumer
that will call methods onTagContactRequest.Builder
to create a request.- Returns:
- Result of the TagContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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
andUserId
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.
- See Also:
-
-
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
andUserId
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 viaTransferContactRequest.builder()
- Parameters:
transferContactRequest
- AConsumer
that will call methods onTransferContactRequest.Builder
to create a request.- Returns:
- Result of the TransferContact operation returned by the service.
- See Also:
-
-
untagContact
default UntagContactResponse untagContact(UntagContactRequest untagContactRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
- Parameters:
untagContactRequest
-- Returns:
- Result of the UntagContact operation returned by the service.
- See Also:
-
untagContact
default UntagContactResponse untagContact(Consumer<UntagContactRequest.Builder> untagContactRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServiceException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, ConnectException Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
This is a convenience which creates an instance of the
UntagContactRequest.Builder
avoiding the need to create one manually viaUntagContactRequest.builder()
- Parameters:
untagContactRequest
- AConsumer
that will call methods onUntagContactRequest.Builder
to create a request.- Returns:
- Result of the UntagContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateAgentStatusRequest.builder()
- Parameters:
updateAgentStatusRequest
- AConsumer
that will call methods onUpdateAgentStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgentStatus operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactRequest.builder()
- Parameters:
updateContactRequest
- AConsumer
that will call methods onUpdateContactRequest.Builder
to create a request.- Returns:
- Result of the UpdateContact operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactAttributesRequest.builder()
- Parameters:
updateContactAttributesRequest
- AConsumer
that will call methods onUpdateContactAttributesRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactAttributes operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactEvaluationRequest.builder()
- Parameters:
updateContactEvaluationRequest
- AConsumer
that will call methods onUpdateContactEvaluationRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactEvaluation operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.- Parameters:
updateContactFlowContentRequest
-- Returns:
- Result of the UpdateContactFlowContent operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.
This is a convenience which creates an instance of the
UpdateContactFlowContentRequest.Builder
avoiding the need to create one manually viaUpdateContactFlowContentRequest.builder()
- Parameters:
updateContactFlowContentRequest
- AConsumer
that will call methods onUpdateContactFlowContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactFlowContent operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactFlowMetadataRequest.builder()
- Parameters:
updateContactFlowMetadataRequest
- AConsumer
that will call methods onUpdateContactFlowMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactFlowMetadata operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.- Parameters:
updateContactFlowModuleContentRequest
-- Returns:
- Result of the UpdateContactFlowModuleContent operation returned by the service.
- See Also:
-
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.
Use the
invalid input: '$'SAVED
alias in the request to describe theSAVED
content of a Flow. For example,arn:aws:.../contact-flow/{id}:invalid input: '$'SAVED
. Once a contact flow is published,invalid input: '$'SAVED
needs to be supplied to view saved content that has not been published.
This is a convenience which creates an instance of the
UpdateContactFlowModuleContentRequest.Builder
avoiding the need to create one manually viaUpdateContactFlowModuleContentRequest.builder()
- Parameters:
updateContactFlowModuleContentRequest
- AConsumer
that will call methods onUpdateContactFlowModuleContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactFlowModuleContent operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactFlowModuleMetadataRequest.builder()
- Parameters:
updateContactFlowModuleMetadataRequest
- AConsumer
that will call methods onUpdateContactFlowModuleMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactFlowModuleMetadata operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactFlowNameRequest.builder()
- Parameters:
updateContactFlowNameRequest
- AConsumer
that will call methods onUpdateContactFlowNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactFlowName operation returned by the service.
- See Also:
-
updateContactRoutingData
default UpdateContactRoutingDataResponse updateContactRoutingData(UpdateContactRoutingDataRequest updateContactRoutingDataRequest) throws ResourceConflictException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
- Parameters:
updateContactRoutingDataRequest
-- Returns:
- Result of the UpdateContactRoutingData operation returned by the service.
- See Also:
-
updateContactRoutingData
default UpdateContactRoutingDataResponse updateContactRoutingData(Consumer<UpdateContactRoutingDataRequest.Builder> updateContactRoutingDataRequest) throws ResourceConflictException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectException This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
This is a convenience which creates an instance of the
UpdateContactRoutingDataRequest.Builder
avoiding the need to create one manually viaUpdateContactRoutingDataRequest.builder()
- Parameters:
updateContactRoutingDataRequest
- AConsumer
that will call methods onUpdateContactRoutingDataRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactRoutingData operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateContactScheduleRequest.builder()
- Parameters:
updateContactScheduleRequest
- AConsumer
that will call methods onUpdateContactScheduleRequest.Builder
to create a request.- Returns:
- Result of the UpdateContactSchedule operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateEvaluationFormRequest.builder()
- Parameters:
updateEvaluationFormRequest
- AConsumer
that will call methods onUpdateEvaluationFormRequest.Builder
to create a request.- Returns:
- Result of the UpdateEvaluationForm operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateHoursOfOperationRequest.builder()
- Parameters:
updateHoursOfOperationRequest
- AConsumer
that will call methods onUpdateHoursOfOperationRequest.Builder
to create a request.- Returns:
- Result of the UpdateHoursOfOperation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateInstanceAttributeRequest.builder()
- Parameters:
updateInstanceAttributeRequest
- AConsumer
that will call methods onUpdateInstanceAttributeRequest.Builder
to create a request.- Returns:
- Result of the UpdateInstanceAttribute operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateInstanceStorageConfigRequest.builder()
- Parameters:
updateInstanceStorageConfigRequest
- AConsumer
that will call methods onUpdateInstanceStorageConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateInstanceStorageConfig operation returned by the service.
- See Also:
-
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.
- See Also:
-
-
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 viaUpdateParticipantRoleConfigRequest.builder()
- Parameters:
updateParticipantRoleConfigRequest
- AConsumer
that will call methods onUpdateParticipantRoleConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateParticipantRoleConfig operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaUpdatePhoneNumberRequest.builder()
- Parameters:
updatePhoneNumberRequest
- AConsumer
that will call methods onUpdatePhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the UpdatePhoneNumber operation returned by the service.
- See Also:
-
updatePhoneNumberMetadata
default UpdatePhoneNumberMetadataResponse updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest) throws InvalidParameterException, InvalidRequestException, AccessDeniedException, ResourceNotFoundException, ResourceInUseException, IdempotencyException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
- Parameters:
updatePhoneNumberMetadataRequest
-- Returns:
- Result of the UpdatePhoneNumberMetadata operation returned by the service.
- See Also:
-
updatePhoneNumberMetadata
default UpdatePhoneNumberMetadataResponse updatePhoneNumberMetadata(Consumer<UpdatePhoneNumberMetadataRequest.Builder> updatePhoneNumberMetadataRequest) throws InvalidParameterException, InvalidRequestException, AccessDeniedException, ResourceNotFoundException, ResourceInUseException, IdempotencyException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
This is a convenience which creates an instance of the
UpdatePhoneNumberMetadataRequest.Builder
avoiding the need to create one manually viaUpdatePhoneNumberMetadataRequest.builder()
- Parameters:
updatePhoneNumberMetadataRequest
- AConsumer
that will call methods onUpdatePhoneNumberMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdatePhoneNumberMetadata operation returned by the service.
- See Also:
-
updatePredefinedAttribute
default UpdatePredefinedAttributeResponse updatePredefinedAttribute(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a predefined attribute for the specified Amazon Connect instance.
- Parameters:
updatePredefinedAttributeRequest
-- Returns:
- Result of the UpdatePredefinedAttribute operation returned by the service.
- See Also:
-
updatePredefinedAttribute
default UpdatePredefinedAttributeResponse updatePredefinedAttribute(Consumer<UpdatePredefinedAttributeRequest.Builder> updatePredefinedAttributeRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a predefined attribute for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
UpdatePredefinedAttributeRequest.Builder
avoiding the need to create one manually viaUpdatePredefinedAttributeRequest.builder()
- Parameters:
updatePredefinedAttributeRequest
- AConsumer
that will call methods onUpdatePredefinedAttributeRequest.Builder
to create a request.- Returns:
- Result of the UpdatePredefinedAttribute operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdatePromptRequest.builder()
- Parameters:
updatePromptRequest
- AConsumer
that will call methods onUpdatePromptRequest.Builder
to create a request.- Returns:
- Result of the UpdatePrompt operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateQueueHoursOfOperationRequest.builder()
- Parameters:
updateQueueHoursOfOperationRequest
- AConsumer
that will call methods onUpdateQueueHoursOfOperationRequest.Builder
to create a request.- Returns:
- Result of the UpdateQueueHoursOfOperation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateQueueMaxContactsRequest.builder()
- Parameters:
updateQueueMaxContactsRequest
- AConsumer
that will call methods onUpdateQueueMaxContactsRequest.Builder
to create a request.- Returns:
- Result of the UpdateQueueMaxContacts operation returned by the service.
- See Also:
-
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
orDescription
must be provided.- Parameters:
updateQueueNameRequest
-- Returns:
- Result of the UpdateQueueName operation returned by the service.
- See Also:
-
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
orDescription
must be provided.
This is a convenience which creates an instance of the
UpdateQueueNameRequest.Builder
avoiding the need to create one manually viaUpdateQueueNameRequest.builder()
- Parameters:
updateQueueNameRequest
- AConsumer
that will call methods onUpdateQueueNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateQueueName operation returned by the service.
- See Also:
-
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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
. -
Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. -
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
- Parameters:
updateQueueOutboundCallerConfigRequest
-- Returns:
- Result of the UpdateQueueOutboundCallerConfig operation returned by the service.
- See Also:
-
-
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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
. -
Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. -
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
This is a convenience which creates an instance of the
UpdateQueueOutboundCallerConfigRequest.Builder
avoiding the need to create one manually viaUpdateQueueOutboundCallerConfigRequest.builder()
- Parameters:
updateQueueOutboundCallerConfigRequest
- AConsumer
that will call methods onUpdateQueueOutboundCallerConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateQueueOutboundCallerConfig operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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 viaUpdateQueueStatusRequest.builder()
- Parameters:
updateQueueStatusRequest
- AConsumer
that will call methods onUpdateQueueStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdateQueueStatus operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateQuickConnectConfigRequest.builder()
- Parameters:
updateQuickConnectConfigRequest
- AConsumer
that will call methods onUpdateQuickConnectConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuickConnectConfig operation returned by the service.
- See Also:
-
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
orDescription
must be provided.- Parameters:
updateQuickConnectNameRequest
-- Returns:
- Result of the UpdateQuickConnectName operation returned by the service.
- See Also:
-
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
orDescription
must be provided.
This is a convenience which creates an instance of the
UpdateQuickConnectNameRequest.Builder
avoiding the need to create one manually viaUpdateQuickConnectNameRequest.builder()
- Parameters:
updateQuickConnectNameRequest
- AConsumer
that will call methods onUpdateQuickConnectNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuickConnectName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateRoutingProfileAgentAvailabilityTimerRequest.builder()
- Parameters:
updateRoutingProfileAgentAvailabilityTimerRequest
- AConsumer
that will call methods onUpdateRoutingProfileAgentAvailabilityTimerRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingProfileAgentAvailabilityTimer operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateRoutingProfileConcurrencyRequest.builder()
- Parameters:
updateRoutingProfileConcurrencyRequest
- AConsumer
that will call methods onUpdateRoutingProfileConcurrencyRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingProfileConcurrency operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateRoutingProfileDefaultOutboundQueueRequest.builder()
- Parameters:
updateRoutingProfileDefaultOutboundQueueRequest
- AConsumer
that will call methods onUpdateRoutingProfileDefaultOutboundQueueRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingProfileDefaultOutboundQueue operation returned by the service.
- See Also:
-
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
orDescription
must be provided.- Parameters:
updateRoutingProfileNameRequest
-- Returns:
- Result of the UpdateRoutingProfileName operation returned by the service.
- See Also:
-
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
orDescription
must be provided.
This is a convenience which creates an instance of the
UpdateRoutingProfileNameRequest.Builder
avoiding the need to create one manually viaUpdateRoutingProfileNameRequest.builder()
- Parameters:
updateRoutingProfileNameRequest
- AConsumer
that will call methods onUpdateRoutingProfileNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingProfileName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateRoutingProfileQueuesRequest.builder()
- Parameters:
updateRoutingProfileQueuesRequest
- AConsumer
that will call methods onUpdateRoutingProfileQueuesRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoutingProfileQueues operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateRuleRequest.builder()
- Parameters:
updateRuleRequest
- AConsumer
that will call methods onUpdateRuleRequest.Builder
to create a request.- Returns:
- Result of the UpdateRule operation returned by the service.
- See Also:
-
updateSecurityProfile
default UpdateSecurityProfileResponse updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a security profile.
- Parameters:
updateSecurityProfileRequest
-- Returns:
- Result of the UpdateSecurityProfile operation returned by the service.
- See Also:
-
updateSecurityProfile
default UpdateSecurityProfileResponse updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates a security profile.
This is a convenience which creates an instance of the
UpdateSecurityProfileRequest.Builder
avoiding the need to create one manually viaUpdateSecurityProfileRequest.builder()
- Parameters:
updateSecurityProfileRequest
- AConsumer
that will call methods onUpdateSecurityProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateSecurityProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateTaskTemplateRequest.builder()
- Parameters:
updateTaskTemplateRequest
- AConsumer
that will call methods onUpdateTaskTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateTaskTemplate operation returned by the service.
- See Also:
-
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.
The
SignInConfig
distribution is available only on a defaultTrafficDistributionGroup
(see theIsDefault
parameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistribution
with a modifiedSignInConfig
and a non-defaultTrafficDistributionGroup
, anInvalidRequestException
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.
- See Also:
-
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.
The
SignInConfig
distribution is available only on a defaultTrafficDistributionGroup
(see theIsDefault
parameter in the TrafficDistributionGroup data type). If you callUpdateTrafficDistribution
with a modifiedSignInConfig
and a non-defaultTrafficDistributionGroup
, anInvalidRequestException
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 viaUpdateTrafficDistributionRequest.builder()
- Parameters:
updateTrafficDistributionRequest
- AConsumer
that will call methods onUpdateTrafficDistributionRequest.Builder
to create a request.- Returns:
- Result of the UpdateTrafficDistribution operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserHierarchyRequest.builder()
- Parameters:
updateUserHierarchyRequest
- AConsumer
that will call methods onUpdateUserHierarchyRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserHierarchy operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserHierarchyGroupNameRequest.builder()
- Parameters:
updateUserHierarchyGroupNameRequest
- AConsumer
that will call methods onUpdateUserHierarchyGroupNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserHierarchyGroupName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserHierarchyStructureRequest.builder()
- Parameters:
updateUserHierarchyStructureRequest
- AConsumer
that will call methods onUpdateUserHierarchyStructureRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserHierarchyStructure operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserIdentityInfoRequest.builder()
- Parameters:
updateUserIdentityInfoRequest
- AConsumer
that will call methods onUpdateUserIdentityInfoRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserIdentityInfo operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserPhoneConfigRequest.builder()
- Parameters:
updateUserPhoneConfigRequest
- AConsumer
that will call methods onUpdateUserPhoneConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserPhoneConfig operation returned by the service.
- See Also:
-
updateUserProficiencies
default UpdateUserProficienciesResponse updateUserProficiencies(UpdateUserProficienciesRequest updateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates the properties associated with the proficiencies of a user.
- Parameters:
updateUserProficienciesRequest
-- Returns:
- Result of the UpdateUserProficiencies operation returned by the service.
- See Also:
-
updateUserProficiencies
default UpdateUserProficienciesResponse updateUserProficiencies(Consumer<UpdateUserProficienciesRequest.Builder> updateUserProficienciesRequest) throws InvalidRequestException, InvalidParameterException, ResourceNotFoundException, ThrottlingException, InternalServiceException, AwsServiceException, SdkClientException, ConnectException Updates the properties associated with the proficiencies of a user.
This is a convenience which creates an instance of the
UpdateUserProficienciesRequest.Builder
avoiding the need to create one manually viaUpdateUserProficienciesRequest.builder()
- Parameters:
updateUserProficienciesRequest
- AConsumer
that will call methods onUpdateUserProficienciesRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserProficiencies operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserRoutingProfileRequest.builder()
- Parameters:
updateUserRoutingProfileRequest
- AConsumer
that will call methods onUpdateUserRoutingProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserRoutingProfile operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateUserSecurityProfilesRequest.builder()
- Parameters:
updateUserSecurityProfilesRequest
- AConsumer
that will call methods onUpdateUserSecurityProfilesRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserSecurityProfiles operation returned by the service.
- See Also:
-
updateViewContent
default UpdateViewContentResponse updateViewContent(UpdateViewContentRequest updateViewContentRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if
Status
is set toSAVED
and performs full content validation ifStatus
isPUBLISHED
. Note that theinvalid input: '$'SAVED
alias' content will always be updated, but theinvalid input: '$'LATEST
alias' content will only be updated ifStatus
isPUBLISHED
.- Parameters:
updateViewContentRequest
-- Returns:
- Result of the UpdateViewContent operation returned by the service.
- See Also:
-
updateViewContent
default UpdateViewContentResponse updateViewContent(Consumer<UpdateViewContentRequest.Builder> updateViewContentRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if
Status
is set toSAVED
and performs full content validation ifStatus
isPUBLISHED
. Note that theinvalid input: '$'SAVED
alias' content will always be updated, but theinvalid input: '$'LATEST
alias' content will only be updated ifStatus
isPUBLISHED
.
This is a convenience which creates an instance of the
UpdateViewContentRequest.Builder
avoiding the need to create one manually viaUpdateViewContentRequest.builder()
- Parameters:
updateViewContentRequest
- AConsumer
that will call methods onUpdateViewContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateViewContent operation returned by the service.
- See Also:
-
updateViewMetadata
default UpdateViewMetadataResponse updateViewMetadata(UpdateViewMetadataRequest updateViewMetadataRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, DuplicateResourceException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Updates the view metadata. Note that either
Name
orDescription
must be provided.- Parameters:
updateViewMetadataRequest
-- Returns:
- Result of the UpdateViewMetadata operation returned by the service.
- See Also:
-
updateViewMetadata
default UpdateViewMetadataResponse updateViewMetadata(Consumer<UpdateViewMetadataRequest.Builder> updateViewMetadataRequest) throws AccessDeniedException, InvalidRequestException, InvalidParameterException, ResourceNotFoundException, InternalServiceException, TooManyRequestsException, DuplicateResourceException, ResourceInUseException, AwsServiceException, SdkClientException, ConnectException Updates the view metadata. Note that either
Name
orDescription
must be provided.
This is a convenience which creates an instance of the
UpdateViewMetadataRequest.Builder
avoiding the need to create one manually viaUpdateViewMetadataRequest.builder()
- Parameters:
updateViewMetadataRequest
- AConsumer
that will call methods onUpdateViewMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateViewMetadata operation returned by the service.
- See Also:
-
create
Create aConnectClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aConnectClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-