Interface ConnectCampaignsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Provide APIs to create and manage Amazon Connect Campaigns.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aConnectCampaignsAsyncClient
.static ConnectCampaignsAsyncClient
create()
Create aConnectCampaignsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateCampaignResponse> createCampaign
(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) Creates a campaign for the specified Amazon Connect account.default CompletableFuture
<CreateCampaignResponse> createCampaign
(CreateCampaignRequest createCampaignRequest) Creates a campaign for the specified Amazon Connect account.default CompletableFuture
<DeleteCampaignResponse> deleteCampaign
(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) Deletes a campaign from the specified Amazon Connect account.default CompletableFuture
<DeleteCampaignResponse> deleteCampaign
(DeleteCampaignRequest deleteCampaignRequest) Deletes a campaign from the specified Amazon Connect account.deleteConnectInstanceConfig
(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest) Deletes a connect instance config from the specified AWS account.deleteConnectInstanceConfig
(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest) Deletes a connect instance config from the specified AWS account.deleteInstanceOnboardingJob
(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.deleteInstanceOnboardingJob
(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.describeCampaign
(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest) Describes the specific campaign.describeCampaign
(DescribeCampaignRequest describeCampaignRequest) Describes the specific campaign.getCampaignState
(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest) Get state of a campaign for the specified Amazon Connect account.getCampaignState
(GetCampaignStateRequest getCampaignStateRequest) Get state of a campaign for the specified Amazon Connect account.getCampaignStateBatch
(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest) Get state of campaigns for the specified Amazon Connect account.getCampaignStateBatch
(GetCampaignStateBatchRequest getCampaignStateBatchRequest) Get state of campaigns for the specified Amazon Connect account.getConnectInstanceConfig
(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest) Get the specific Connect instance config.getConnectInstanceConfig
(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest) Get the specific Connect instance config.getInstanceOnboardingJobStatus
(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest) Get the specific instance onboarding job status.getInstanceOnboardingJobStatus
(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest) Get the specific instance onboarding job status.default CompletableFuture
<ListCampaignsResponse> listCampaigns
(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) Provides summary information about the campaigns under the specified Amazon Connect account.default CompletableFuture
<ListCampaignsResponse> listCampaigns
(ListCampaignsRequest listCampaignsRequest) Provides summary information about the campaigns under the specified Amazon Connect account.default ListCampaignsPublisher
listCampaignsPaginator
(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) This is a variant oflistCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.default ListCampaignsPublisher
listCampaignsPaginator
(ListCampaignsRequest listCampaignsRequest) This is a variant oflistCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a resource.default CompletableFuture
<PauseCampaignResponse> pauseCampaign
(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest) Pauses a campaign for the specified Amazon Connect account.default CompletableFuture
<PauseCampaignResponse> pauseCampaign
(PauseCampaignRequest pauseCampaignRequest) Pauses a campaign for the specified Amazon Connect account.putDialRequestBatch
(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest) Creates dials requests for the specified campaign Amazon Connect account.putDialRequestBatch
(PutDialRequestBatchRequest putDialRequestBatchRequest) Creates dials requests for the specified campaign Amazon Connect account.default CompletableFuture
<ResumeCampaignResponse> resumeCampaign
(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest) Stops a campaign for the specified Amazon Connect account.default CompletableFuture
<ResumeCampaignResponse> resumeCampaign
(ResumeCampaignRequest resumeCampaignRequest) Stops a campaign for the specified Amazon Connect account.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartCampaignResponse> startCampaign
(Consumer<StartCampaignRequest.Builder> startCampaignRequest) Starts a campaign for the specified Amazon Connect account.default CompletableFuture
<StartCampaignResponse> startCampaign
(StartCampaignRequest startCampaignRequest) Starts a campaign for the specified Amazon Connect account.startInstanceOnboardingJob
(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest) Onboard the specific Amazon Connect instance to Connect Campaigns.startInstanceOnboardingJob
(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest) Onboard the specific Amazon Connect instance to Connect Campaigns.default CompletableFuture
<StopCampaignResponse> stopCampaign
(Consumer<StopCampaignRequest.Builder> stopCampaignRequest) Stops a campaign for the specified Amazon Connect account.default CompletableFuture
<StopCampaignResponse> stopCampaign
(StopCampaignRequest stopCampaignRequest) Stops a campaign for the specified Amazon Connect account.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Tag a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untag a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Untag a resource.updateCampaignDialerConfig
(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest) Updates the dialer config of a campaign.updateCampaignDialerConfig
(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest) Updates the dialer config of a campaign.updateCampaignName
(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest) Updates the name of a campaign.updateCampaignName
(UpdateCampaignNameRequest updateCampaignNameRequest) Updates the name of a campaign.updateCampaignOutboundCallConfig
(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest) Updates the outbound call config of a campaign.updateCampaignOutboundCallConfig
(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest) Updates the outbound call config of a campaign.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
-
createCampaign
default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest) Creates a campaign for the specified Amazon Connect account. This API is idempotent.
- Parameters:
createCampaignRequest
- The request for Create Campaign API.- Returns:
- A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCampaign
default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) Creates a campaign for the specified Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the
CreateCampaignRequest.Builder
avoiding the need to create one manually viaCreateCampaignRequest.builder()
- Parameters:
createCampaignRequest
- AConsumer
that will call methods onCreateCampaignRequest.Builder
to create a request. The request for Create Campaign API.- Returns:
- A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCampaign
default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Deletes a campaign from the specified Amazon Connect account.
- Parameters:
deleteCampaignRequest
- DeleteCampaignRequest- Returns:
- A Java Future containing the result of the DeleteCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCampaign
default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) Deletes a campaign from the specified Amazon Connect account.
This is a convenience which creates an instance of the
DeleteCampaignRequest.Builder
avoiding the need to create one manually viaDeleteCampaignRequest.builder()
- Parameters:
deleteCampaignRequest
- AConsumer
that will call methods onDeleteCampaignRequest.Builder
to create a request. DeleteCampaignRequest- Returns:
- A Java Future containing the result of the DeleteCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnectInstanceConfig
default CompletableFuture<DeleteConnectInstanceConfigResponse> deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest) Deletes a connect instance config from the specified AWS account.
- Parameters:
deleteConnectInstanceConfigRequest
- DeleteCampaignRequest- Returns:
- A Java Future containing the result of the DeleteConnectInstanceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidStateException The request could not be processed because of conflict in the current state.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnectInstanceConfig
default CompletableFuture<DeleteConnectInstanceConfigResponse> deleteConnectInstanceConfig(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest) Deletes a connect instance config from the specified AWS account.
This is a convenience which creates an instance of the
DeleteConnectInstanceConfigRequest.Builder
avoiding the need to create one manually viaDeleteConnectInstanceConfigRequest.builder()
- Parameters:
deleteConnectInstanceConfigRequest
- AConsumer
that will call methods onDeleteConnectInstanceConfigRequest.Builder
to create a request. DeleteCampaignRequest- Returns:
- A Java Future containing the result of the DeleteConnectInstanceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidStateException The request could not be processed because of conflict in the current state.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInstanceOnboardingJob
default CompletableFuture<DeleteInstanceOnboardingJobResponse> deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
- Parameters:
deleteInstanceOnboardingJobRequest
- The request for DeleteInstanceOnboardingJob API.- Returns:
- A Java Future containing the result of the DeleteInstanceOnboardingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidStateException The request could not be processed because of conflict in the current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInstanceOnboardingJob
default CompletableFuture<DeleteInstanceOnboardingJobResponse> deleteInstanceOnboardingJob(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
DeleteInstanceOnboardingJobRequest.Builder
avoiding the need to create one manually viaDeleteInstanceOnboardingJobRequest.builder()
- Parameters:
deleteInstanceOnboardingJobRequest
- AConsumer
that will call methods onDeleteInstanceOnboardingJobRequest.Builder
to create a request. The request for DeleteInstanceOnboardingJob API.- Returns:
- A Java Future containing the result of the DeleteInstanceOnboardingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidStateException The request could not be processed because of conflict in the current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCampaign
default CompletableFuture<DescribeCampaignResponse> describeCampaign(DescribeCampaignRequest describeCampaignRequest) Describes the specific campaign.
- Parameters:
describeCampaignRequest
- DescribeCampaignRequests- Returns:
- A Java Future containing the result of the DescribeCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCampaign
default CompletableFuture<DescribeCampaignResponse> describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest) Describes the specific campaign.
This is a convenience which creates an instance of the
DescribeCampaignRequest.Builder
avoiding the need to create one manually viaDescribeCampaignRequest.builder()
- Parameters:
describeCampaignRequest
- AConsumer
that will call methods onDescribeCampaignRequest.Builder
to create a request. DescribeCampaignRequests- Returns:
- A Java Future containing the result of the DescribeCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCampaignState
default CompletableFuture<GetCampaignStateResponse> getCampaignState(GetCampaignStateRequest getCampaignStateRequest) Get state of a campaign for the specified Amazon Connect account.
- Parameters:
getCampaignStateRequest
- GetCampaignStateRequest- Returns:
- A Java Future containing the result of the GetCampaignState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCampaignState
default CompletableFuture<GetCampaignStateResponse> getCampaignState(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest) Get state of a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the
GetCampaignStateRequest.Builder
avoiding the need to create one manually viaGetCampaignStateRequest.builder()
- Parameters:
getCampaignStateRequest
- AConsumer
that will call methods onGetCampaignStateRequest.Builder
to create a request. GetCampaignStateRequest- Returns:
- A Java Future containing the result of the GetCampaignState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCampaignStateBatch
default CompletableFuture<GetCampaignStateBatchResponse> getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest) Get state of campaigns for the specified Amazon Connect account.
- Parameters:
getCampaignStateBatchRequest
- GetCampaignStateBatchRequest- Returns:
- A Java Future containing the result of the GetCampaignStateBatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCampaignStateBatch
default CompletableFuture<GetCampaignStateBatchResponse> getCampaignStateBatch(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest) Get state of campaigns for the specified Amazon Connect account.
This is a convenience which creates an instance of the
GetCampaignStateBatchRequest.Builder
avoiding the need to create one manually viaGetCampaignStateBatchRequest.builder()
- Parameters:
getCampaignStateBatchRequest
- AConsumer
that will call methods onGetCampaignStateBatchRequest.Builder
to create a request. GetCampaignStateBatchRequest- Returns:
- A Java Future containing the result of the GetCampaignStateBatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectInstanceConfig
default CompletableFuture<GetConnectInstanceConfigResponse> getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest) Get the specific Connect instance config.
- Parameters:
getConnectInstanceConfigRequest
- GetConnectInstanceConfigRequest- Returns:
- A Java Future containing the result of the GetConnectInstanceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectInstanceConfig
default CompletableFuture<GetConnectInstanceConfigResponse> getConnectInstanceConfig(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest) Get the specific Connect instance config.
This is a convenience which creates an instance of the
GetConnectInstanceConfigRequest.Builder
avoiding the need to create one manually viaGetConnectInstanceConfigRequest.builder()
- Parameters:
getConnectInstanceConfigRequest
- AConsumer
that will call methods onGetConnectInstanceConfigRequest.Builder
to create a request. GetConnectInstanceConfigRequest- Returns:
- A Java Future containing the result of the GetConnectInstanceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInstanceOnboardingJobStatus
default CompletableFuture<GetInstanceOnboardingJobStatusResponse> getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest) Get the specific instance onboarding job status.
- Parameters:
getInstanceOnboardingJobStatusRequest
- GetInstanceOnboardingJobStatusRequest- Returns:
- A Java Future containing the result of the GetInstanceOnboardingJobStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInstanceOnboardingJobStatus
default CompletableFuture<GetInstanceOnboardingJobStatusResponse> getInstanceOnboardingJobStatus(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest) Get the specific instance onboarding job status.
This is a convenience which creates an instance of the
GetInstanceOnboardingJobStatusRequest.Builder
avoiding the need to create one manually viaGetInstanceOnboardingJobStatusRequest.builder()
- Parameters:
getInstanceOnboardingJobStatusRequest
- AConsumer
that will call methods onGetInstanceOnboardingJobStatusRequest.Builder
to create a request. GetInstanceOnboardingJobStatusRequest- Returns:
- A Java Future containing the result of the GetInstanceOnboardingJobStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCampaigns
default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest) Provides summary information about the campaigns under the specified Amazon Connect account.
- Parameters:
listCampaignsRequest
- ListCampaignsRequest- Returns:
- A Java Future containing the result of the ListCampaigns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCampaigns
default CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) Provides summary information about the campaigns under the specified Amazon Connect account.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builder
avoiding the need to create one manually viaListCampaignsRequest.builder()
- Parameters:
listCampaignsRequest
- AConsumer
that will call methods onListCampaignsRequest.Builder
to create a request. ListCampaignsRequest- Returns:
- A Java Future containing the result of the ListCampaigns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCampaignsPaginator
This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response) { //... }; });
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
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.- Parameters:
listCampaignsRequest
- ListCampaignsRequest- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCampaignsPaginator
default ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response) { //... }; });
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
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builder
avoiding the need to create one manually viaListCampaignsRequest.builder()
- Parameters:
listCampaignsRequest
- AConsumer
that will call methods onListCampaignsRequest.Builder
to create a request. ListCampaignsRequest- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a resource.
- Parameters:
listTagsForResourceRequest
- ListTagsForResource- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a resource.
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. ListTagsForResource- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pauseCampaign
default CompletableFuture<PauseCampaignResponse> pauseCampaign(PauseCampaignRequest pauseCampaignRequest) Pauses a campaign for the specified Amazon Connect account.
- Parameters:
pauseCampaignRequest
- PauseCampaignRequest- Returns:
- A Java Future containing the result of the PauseCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pauseCampaign
default CompletableFuture<PauseCampaignResponse> pauseCampaign(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest) Pauses a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the
PauseCampaignRequest.Builder
avoiding the need to create one manually viaPauseCampaignRequest.builder()
- Parameters:
pauseCampaignRequest
- AConsumer
that will call methods onPauseCampaignRequest.Builder
to create a request. PauseCampaignRequest- Returns:
- A Java Future containing the result of the PauseCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDialRequestBatch
default CompletableFuture<PutDialRequestBatchResponse> putDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest) Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
- Parameters:
putDialRequestBatchRequest
- PutDialRequestBatchRequest- Returns:
- A Java Future containing the result of the PutDialRequestBatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDialRequestBatch
default CompletableFuture<PutDialRequestBatchResponse> putDialRequestBatch(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest) Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the
PutDialRequestBatchRequest.Builder
avoiding the need to create one manually viaPutDialRequestBatchRequest.builder()
- Parameters:
putDialRequestBatchRequest
- AConsumer
that will call methods onPutDialRequestBatchRequest.Builder
to create a request. PutDialRequestBatchRequest- Returns:
- A Java Future containing the result of the PutDialRequestBatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeCampaign
default CompletableFuture<ResumeCampaignResponse> resumeCampaign(ResumeCampaignRequest resumeCampaignRequest) Stops a campaign for the specified Amazon Connect account.
- Parameters:
resumeCampaignRequest
- ResumeCampaignRequest- Returns:
- A Java Future containing the result of the ResumeCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeCampaign
default CompletableFuture<ResumeCampaignResponse> resumeCampaign(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest) Stops a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the
ResumeCampaignRequest.Builder
avoiding the need to create one manually viaResumeCampaignRequest.builder()
- Parameters:
resumeCampaignRequest
- AConsumer
that will call methods onResumeCampaignRequest.Builder
to create a request. ResumeCampaignRequest- Returns:
- A Java Future containing the result of the ResumeCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCampaign
default CompletableFuture<StartCampaignResponse> startCampaign(StartCampaignRequest startCampaignRequest) Starts a campaign for the specified Amazon Connect account.
- Parameters:
startCampaignRequest
- StartCampaignRequest- Returns:
- A Java Future containing the result of the StartCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCampaign
default CompletableFuture<StartCampaignResponse> startCampaign(Consumer<StartCampaignRequest.Builder> startCampaignRequest) Starts a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the
StartCampaignRequest.Builder
avoiding the need to create one manually viaStartCampaignRequest.builder()
- Parameters:
startCampaignRequest
- AConsumer
that will call methods onStartCampaignRequest.Builder
to create a request. StartCampaignRequest- Returns:
- A Java Future containing the result of the StartCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startInstanceOnboardingJob
default CompletableFuture<StartInstanceOnboardingJobResponse> startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest) Onboard the specific Amazon Connect instance to Connect Campaigns.
- Parameters:
startInstanceOnboardingJobRequest
- The request for StartInstanceOnboardingJob API.- Returns:
- A Java Future containing the result of the StartInstanceOnboardingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startInstanceOnboardingJob
default CompletableFuture<StartInstanceOnboardingJobResponse> startInstanceOnboardingJob(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest) Onboard the specific Amazon Connect instance to Connect Campaigns.
This is a convenience which creates an instance of the
StartInstanceOnboardingJobRequest.Builder
avoiding the need to create one manually viaStartInstanceOnboardingJobRequest.builder()
- Parameters:
startInstanceOnboardingJobRequest
- AConsumer
that will call methods onStartInstanceOnboardingJobRequest.Builder
to create a request. The request for StartInstanceOnboardingJob API.- Returns:
- A Java Future containing the result of the StartInstanceOnboardingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopCampaign
default CompletableFuture<StopCampaignResponse> stopCampaign(StopCampaignRequest stopCampaignRequest) Stops a campaign for the specified Amazon Connect account.
- Parameters:
stopCampaignRequest
- StopCampaignRequest- Returns:
- A Java Future containing the result of the StopCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopCampaign
default CompletableFuture<StopCampaignResponse> stopCampaign(Consumer<StopCampaignRequest.Builder> stopCampaignRequest) Stops a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the
StopCampaignRequest.Builder
avoiding the need to create one manually viaStopCampaignRequest.builder()
- Parameters:
stopCampaignRequest
- AConsumer
that will call methods onStopCampaignRequest.Builder
to create a request. StopCampaignRequest- Returns:
- A Java Future containing the result of the StopCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- InvalidCampaignStateException The request could not be processed because of conflict in the current state of the campaign.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tag a resource.
- Parameters:
tagResourceRequest
- TagResourceRequest- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag a resource.
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. TagResourceRequest- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Untag a resource.
- Parameters:
untagResourceRequest
- UntagResourceRequest- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untag a 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. UntagResourceRequest- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignDialerConfig
default CompletableFuture<UpdateCampaignDialerConfigResponse> updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest) Updates the dialer config of a campaign. This API is idempotent.
- Parameters:
updateCampaignDialerConfigRequest
- UpdateCampaignDialerConfigRequest- Returns:
- A Java Future containing the result of the UpdateCampaignDialerConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignDialerConfig
default CompletableFuture<UpdateCampaignDialerConfigResponse> updateCampaignDialerConfig(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest) Updates the dialer config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignDialerConfigRequest.Builder
avoiding the need to create one manually viaUpdateCampaignDialerConfigRequest.builder()
- Parameters:
updateCampaignDialerConfigRequest
- AConsumer
that will call methods onUpdateCampaignDialerConfigRequest.Builder
to create a request. UpdateCampaignDialerConfigRequest- Returns:
- A Java Future containing the result of the UpdateCampaignDialerConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignName
default CompletableFuture<UpdateCampaignNameResponse> updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest) Updates the name of a campaign. This API is idempotent.
- Parameters:
updateCampaignNameRequest
- UpdateCampaignNameRequest- Returns:
- A Java Future containing the result of the UpdateCampaignName operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignName
default CompletableFuture<UpdateCampaignNameResponse> updateCampaignName(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest) Updates the name of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignNameRequest.Builder
avoiding the need to create one manually viaUpdateCampaignNameRequest.builder()
- Parameters:
updateCampaignNameRequest
- AConsumer
that will call methods onUpdateCampaignNameRequest.Builder
to create a request. UpdateCampaignNameRequest- Returns:
- A Java Future containing the result of the UpdateCampaignName operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignOutboundCallConfig
default CompletableFuture<UpdateCampaignOutboundCallConfigResponse> updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest) Updates the outbound call config of a campaign. This API is idempotent.
- Parameters:
updateCampaignOutboundCallConfigRequest
- UpdateCampaignOutboundCallConfigRequest- Returns:
- A Java Future containing the result of the UpdateCampaignOutboundCallConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCampaignOutboundCallConfig
default CompletableFuture<UpdateCampaignOutboundCallConfigResponse> updateCampaignOutboundCallConfig(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest) Updates the outbound call config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignOutboundCallConfigRequest.Builder
avoiding the need to create one manually viaUpdateCampaignOutboundCallConfigRequest.builder()
- Parameters:
updateCampaignOutboundCallConfigRequest
- AConsumer
that will call methods onUpdateCampaignOutboundCallConfigRequest.Builder
to create a request. UpdateCampaignOutboundCallConfigRequest- Returns:
- A Java Future containing the result of the UpdateCampaignOutboundCallConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Request processing failed because of an error or failure with the service.
- ResourceNotFoundException The specified resource was not found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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
-
create
Create aConnectCampaignsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aConnectCampaignsAsyncClient
.
-