Interface ConnectCampaignsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCampaignsAsyncClient extends AwsClient
Service client for accessing AmazonConnectCampaignService asynchronously. This can be created using the static 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 Details

  • 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 invoke Throwable.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 via CreateCampaignRequest.builder()

      Parameters:
      createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via DeleteCampaignRequest.builder()

      Parameters:
      deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via DeleteConnectInstanceConfigRequest.builder()

      Parameters:
      deleteConnectInstanceConfigRequest - A Consumer that will call methods on DeleteConnectInstanceConfigRequest.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 invoke Throwable.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 invoke Throwable.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 via DeleteInstanceOnboardingJobRequest.builder()

      Parameters:
      deleteInstanceOnboardingJobRequest - A Consumer that will call methods on DeleteInstanceOnboardingJobRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeCampaignRequest.builder()

      Parameters:
      describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via GetCampaignStateRequest.builder()

      Parameters:
      getCampaignStateRequest - A Consumer that will call methods on GetCampaignStateRequest.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 invoke Throwable.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 invoke Throwable.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 via GetCampaignStateBatchRequest.builder()

      Parameters:
      getCampaignStateBatchRequest - A Consumer that will call methods on GetCampaignStateBatchRequest.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 invoke Throwable.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 invoke Throwable.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 via GetConnectInstanceConfigRequest.builder()

      Parameters:
      getConnectInstanceConfigRequest - A Consumer that will call methods on GetConnectInstanceConfigRequest.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 invoke Throwable.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 invoke Throwable.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 via GetInstanceOnboardingJobStatusRequest.builder()

      Parameters:
      getInstanceOnboardingJobStatusRequest - A Consumer that will call methods on GetInstanceOnboardingJobStatusRequest.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 invoke Throwable.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 invoke Throwable.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 via ListCampaignsRequest.builder()

      Parameters:
      listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.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 invoke Throwable.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(ListCampaignsRequest 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription 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 method 
       
 software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListCampaignsRequest.builder()

      Parameters:
      listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.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 invoke Throwable.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 invoke Throwable.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 via PauseCampaignRequest.builder()

      Parameters:
      pauseCampaignRequest - A Consumer that will call methods on PauseCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via PutDialRequestBatchRequest.builder()

      Parameters:
      putDialRequestBatchRequest - A Consumer that will call methods on PutDialRequestBatchRequest.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 invoke Throwable.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 invoke Throwable.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 via ResumeCampaignRequest.builder()

      Parameters:
      resumeCampaignRequest - A Consumer that will call methods on ResumeCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via StartCampaignRequest.builder()

      Parameters:
      startCampaignRequest - A Consumer that will call methods on StartCampaignRequest.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 invoke Throwable.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 invoke Throwable.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 via StartInstanceOnboardingJobRequest.builder()

      Parameters:
      startInstanceOnboardingJobRequest - A Consumer that will call methods on StartInstanceOnboardingJobRequest.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 invoke Throwable.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 invoke Throwable.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 via StopCampaignRequest.builder()

      Parameters:
      stopCampaignRequest - A Consumer that will call methods on StopCampaignRequest.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 invoke Throwable.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

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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 invoke Throwable.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 via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.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 invoke Throwable.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 invoke Throwable.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 via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.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 invoke Throwable.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 invoke Throwable.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 via UpdateCampaignDialerConfigRequest.builder()

      Parameters:
      updateCampaignDialerConfigRequest - A Consumer that will call methods on UpdateCampaignDialerConfigRequest.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 invoke Throwable.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 invoke Throwable.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 via UpdateCampaignNameRequest.builder()

      Parameters:
      updateCampaignNameRequest - A Consumer that will call methods on UpdateCampaignNameRequest.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 invoke Throwable.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 invoke Throwable.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 via UpdateCampaignOutboundCallConfigRequest.builder()

      Parameters:
      updateCampaignOutboundCallConfigRequest - A Consumer that will call methods on UpdateCampaignOutboundCallConfigRequest.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 invoke Throwable.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

      default ConnectCampaignsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ConnectCampaignsAsyncClient create()
      Create a ConnectCampaignsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ConnectCampaignsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ConnectCampaignsAsyncClient.