Interface ConnectCampaignsV2AsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCampaignsV2AsyncClient extends AwsClient
Service client for accessing AmazonConnectCampaignServiceV2 asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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 CreateCampaign 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateCampaignRequest.builder()- Parameters:
createCampaignRequest- AConsumerthat will call methods onCreateCampaignRequest.Builderto create a request. The request for CreateCampaign 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaign
default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Deletes a campaign from the specified Amazon Connect account.
- Parameters:
deleteCampaignRequest- The request for DeleteCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteCampaignRequest.builder()- Parameters:
deleteCampaignRequest- AConsumerthat will call methods onDeleteCampaignRequest.Builderto create a request. The request for DeleteCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignChannelSubtypeConfig
default CompletableFuture<DeleteCampaignChannelSubtypeConfigResponse> deleteCampaignChannelSubtypeConfig(DeleteCampaignChannelSubtypeConfigRequest deleteCampaignChannelSubtypeConfigRequest)
Deletes the channel subtype config of a campaign. This API is idempotent.
- Parameters:
deleteCampaignChannelSubtypeConfigRequest- The request for DeleteCampaignChannelSubtypeConfig API.- Returns:
- A Java Future containing the result of the DeleteCampaignChannelSubtypeConfig 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignChannelSubtypeConfig
default CompletableFuture<DeleteCampaignChannelSubtypeConfigResponse> deleteCampaignChannelSubtypeConfig(Consumer<DeleteCampaignChannelSubtypeConfigRequest.Builder> deleteCampaignChannelSubtypeConfigRequest)
Deletes the channel subtype config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
DeleteCampaignChannelSubtypeConfigRequest.Builderavoiding the need to create one manually viaDeleteCampaignChannelSubtypeConfigRequest.builder()- Parameters:
deleteCampaignChannelSubtypeConfigRequest- AConsumerthat will call methods onDeleteCampaignChannelSubtypeConfigRequest.Builderto create a request. The request for DeleteCampaignChannelSubtypeConfig API.- Returns:
- A Java Future containing the result of the DeleteCampaignChannelSubtypeConfig 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignCommunicationLimits
default CompletableFuture<DeleteCampaignCommunicationLimitsResponse> deleteCampaignCommunicationLimits(DeleteCampaignCommunicationLimitsRequest deleteCampaignCommunicationLimitsRequest)
Deletes the communication limits config for a campaign. This API is idempotent.
- Parameters:
deleteCampaignCommunicationLimitsRequest- The request for DeleteCampaignCommunicationLimits API.- Returns:
- A Java Future containing the result of the DeleteCampaignCommunicationLimits 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignCommunicationLimits
default CompletableFuture<DeleteCampaignCommunicationLimitsResponse> deleteCampaignCommunicationLimits(Consumer<DeleteCampaignCommunicationLimitsRequest.Builder> deleteCampaignCommunicationLimitsRequest)
Deletes the communication limits config for a campaign. This API is idempotent.
This is a convenience which creates an instance of the
DeleteCampaignCommunicationLimitsRequest.Builderavoiding the need to create one manually viaDeleteCampaignCommunicationLimitsRequest.builder()- Parameters:
deleteCampaignCommunicationLimitsRequest- AConsumerthat will call methods onDeleteCampaignCommunicationLimitsRequest.Builderto create a request. The request for DeleteCampaignCommunicationLimits API.- Returns:
- A Java Future containing the result of the DeleteCampaignCommunicationLimits 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignCommunicationTime
default CompletableFuture<DeleteCampaignCommunicationTimeResponse> deleteCampaignCommunicationTime(DeleteCampaignCommunicationTimeRequest deleteCampaignCommunicationTimeRequest)
Deletes the communication time config for a campaign. This API is idempotent.
- Parameters:
deleteCampaignCommunicationTimeRequest- The request for DeleteCampaignCommunicationTime API.- Returns:
- A Java Future containing the result of the DeleteCampaignCommunicationTime 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCampaignCommunicationTime
default CompletableFuture<DeleteCampaignCommunicationTimeResponse> deleteCampaignCommunicationTime(Consumer<DeleteCampaignCommunicationTimeRequest.Builder> deleteCampaignCommunicationTimeRequest)
Deletes the communication time config for a campaign. This API is idempotent.
This is a convenience which creates an instance of the
DeleteCampaignCommunicationTimeRequest.Builderavoiding the need to create one manually viaDeleteCampaignCommunicationTimeRequest.builder()- Parameters:
deleteCampaignCommunicationTimeRequest- AConsumerthat will call methods onDeleteCampaignCommunicationTimeRequest.Builderto create a request. The request for DeleteCampaignCommunicationTime API.- Returns:
- A Java Future containing the result of the DeleteCampaignCommunicationTime 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConnectInstanceConfig
default CompletableFuture<DeleteConnectInstanceConfigResponse> deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest)
Deletes a connect instance config from the specified AWS account.
- Parameters:
deleteConnectInstanceConfigRequest- The request for DeleteConnectInstanceConfig API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteConnectInstanceConfigRequest.builder()- Parameters:
deleteConnectInstanceConfigRequest- AConsumerthat will call methods onDeleteConnectInstanceConfigRequest.Builderto create a request. The request for DeleteConnectInstanceConfig API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConnectInstanceIntegration
default CompletableFuture<DeleteConnectInstanceIntegrationResponse> deleteConnectInstanceIntegration(DeleteConnectInstanceIntegrationRequest deleteConnectInstanceIntegrationRequest)
Delete the integration for the specified Amazon Connect instance.
- Parameters:
deleteConnectInstanceIntegrationRequest- The request for DeleteConnectInstanceIntegration API.- Returns:
- A Java Future containing the result of the DeleteConnectInstanceIntegration 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConnectInstanceIntegration
default CompletableFuture<DeleteConnectInstanceIntegrationResponse> deleteConnectInstanceIntegration(Consumer<DeleteConnectInstanceIntegrationRequest.Builder> deleteConnectInstanceIntegrationRequest)
Delete the integration for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
DeleteConnectInstanceIntegrationRequest.Builderavoiding the need to create one manually viaDeleteConnectInstanceIntegrationRequest.builder()- Parameters:
deleteConnectInstanceIntegrationRequest- AConsumerthat will call methods onDeleteConnectInstanceIntegrationRequest.Builderto create a request. The request for DeleteConnectInstanceIntegration API.- Returns:
- A Java Future containing the result of the DeleteConnectInstanceIntegration 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteInstanceOnboardingJobRequest.builder()- Parameters:
deleteInstanceOnboardingJobRequest- AConsumerthat will call methods onDeleteInstanceOnboardingJobRequest.Builderto 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeCampaign
default CompletableFuture<DescribeCampaignResponse> describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the specific campaign.
- Parameters:
describeCampaignRequest- The request for DescribeCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeCampaign
default CompletableFuture<DescribeCampaignResponse> describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the specific campaign.
This is a convenience which creates an instance of the
DescribeCampaignRequest.Builderavoiding the need to create one manually viaDescribeCampaignRequest.builder()- Parameters:
describeCampaignRequest- AConsumerthat will call methods onDescribeCampaignRequest.Builderto create a request. The request for DescribeCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getCampaignState
default CompletableFuture<GetCampaignStateResponse> getCampaignState(GetCampaignStateRequest getCampaignStateRequest)
Get state of a campaign for the specified Amazon Connect account.
- Parameters:
getCampaignStateRequest- The request for GetCampaignState API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetCampaignStateRequest.builder()- Parameters:
getCampaignStateRequest- AConsumerthat will call methods onGetCampaignStateRequest.Builderto create a request. The request for GetCampaignState API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getCampaignStateBatch
default CompletableFuture<GetCampaignStateBatchResponse> getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest)
Get state of campaigns for the specified Amazon Connect account.
- Parameters:
getCampaignStateBatchRequest- The request for GetCampaignStateBatch API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetCampaignStateBatchRequest.builder()- Parameters:
getCampaignStateBatchRequest- AConsumerthat will call methods onGetCampaignStateBatchRequest.Builderto create a request. The request for GetCampaignStateBatch API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConnectInstanceConfig
default CompletableFuture<GetConnectInstanceConfigResponse> getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest)
Get the specific Connect instance config.
- Parameters:
getConnectInstanceConfigRequest- The request for GetConnectInstanceConfig API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetConnectInstanceConfigRequest.builder()- Parameters:
getConnectInstanceConfigRequest- AConsumerthat will call methods onGetConnectInstanceConfigRequest.Builderto create a request. The request for GetConnectInstanceConfig API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getInstanceOnboardingJobStatus
default CompletableFuture<GetInstanceOnboardingJobStatusResponse> getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest)
Get the specific instance onboarding job status.
- Parameters:
getInstanceOnboardingJobStatusRequest- The request for GetInstanceOnboardingJobStatus API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetInstanceOnboardingJobStatusRequest.builder()- Parameters:
getInstanceOnboardingJobStatusRequest- AConsumerthat will call methods onGetInstanceOnboardingJobStatusRequest.Builderto create a request. The request for GetInstanceOnboardingJobStatus API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listCampaigns
default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
- Parameters:
listCampaignsRequest- The request for ListCampaigns API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListCampaignsRequest.builder()- Parameters:
listCampaignsRequest- AConsumerthat will call methods onListCampaignsRequest.Builderto create a request. The request for ListCampaigns API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listCampaignsPaginator
default ListCampaignsPublisher listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaignsv2.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.connectcampaignsv2.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connectcampaignsv2.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaignsv2.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaignsv2.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.connectcampaignsv2.model.ListCampaignsRequest)operation.- Parameters:
listCampaignsRequest- The request for ListCampaigns API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listCampaignsPaginator
default ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaignsv2.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.connectcampaignsv2.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connectcampaignsv2.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaignsv2.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaignsv2.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.connectcampaignsv2.model.ListCampaignsRequest)operation.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builderavoiding the need to create one manually viaListCampaignsRequest.builder()- Parameters:
listCampaignsRequest- AConsumerthat will call methods onListCampaignsRequest.Builderto create a request. The request for ListCampaigns API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectInstanceIntegrations
default CompletableFuture<ListConnectInstanceIntegrationsResponse> listConnectInstanceIntegrations(ListConnectInstanceIntegrationsRequest listConnectInstanceIntegrationsRequest)
Provides summary information about the integration under the specified Connect instance.
- Parameters:
listConnectInstanceIntegrationsRequest- The request for ListConnectInstanceIntegrations API.- Returns:
- A Java Future containing the result of the ListConnectInstanceIntegrations 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectInstanceIntegrations
default CompletableFuture<ListConnectInstanceIntegrationsResponse> listConnectInstanceIntegrations(Consumer<ListConnectInstanceIntegrationsRequest.Builder> listConnectInstanceIntegrationsRequest)
Provides summary information about the integration under the specified Connect instance.
This is a convenience which creates an instance of the
ListConnectInstanceIntegrationsRequest.Builderavoiding the need to create one manually viaListConnectInstanceIntegrationsRequest.builder()- Parameters:
listConnectInstanceIntegrationsRequest- AConsumerthat will call methods onListConnectInstanceIntegrationsRequest.Builderto create a request. The request for ListConnectInstanceIntegrations API.- Returns:
- A Java Future containing the result of the ListConnectInstanceIntegrations 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectInstanceIntegrationsPaginator
default ListConnectInstanceIntegrationsPublisher listConnectInstanceIntegrationsPaginator(ListConnectInstanceIntegrationsRequest listConnectInstanceIntegrationsRequest)
This is a variant of
listConnectInstanceIntegrations(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.connectcampaignsv2.paginators.ListConnectInstanceIntegrationsPublisher publisher = client.listConnectInstanceIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connectcampaignsv2.paginators.ListConnectInstanceIntegrationsPublisher publisher = client.listConnectInstanceIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsResponse 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
listConnectInstanceIntegrations(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsRequest)operation.- Parameters:
listConnectInstanceIntegrationsRequest- The request for ListConnectInstanceIntegrations API.- 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.
- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectInstanceIntegrationsPaginator
default ListConnectInstanceIntegrationsPublisher listConnectInstanceIntegrationsPaginator(Consumer<ListConnectInstanceIntegrationsRequest.Builder> listConnectInstanceIntegrationsRequest)
This is a variant of
listConnectInstanceIntegrations(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.connectcampaignsv2.paginators.ListConnectInstanceIntegrationsPublisher publisher = client.listConnectInstanceIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connectcampaignsv2.paginators.ListConnectInstanceIntegrationsPublisher publisher = client.listConnectInstanceIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsResponse 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
listConnectInstanceIntegrations(software.amazon.awssdk.services.connectcampaignsv2.model.ListConnectInstanceIntegrationsRequest)operation.
This is a convenience which creates an instance of the
ListConnectInstanceIntegrationsRequest.Builderavoiding the need to create one manually viaListConnectInstanceIntegrationsRequest.builder()- Parameters:
listConnectInstanceIntegrationsRequest- AConsumerthat will call methods onListConnectInstanceIntegrationsRequest.Builderto create a request. The request for ListConnectInstanceIntegrations API.- 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.
- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a resource.
- Parameters:
listTagsForResourceRequest- The request for ListTagsForResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. The request for ListTagsForResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
pauseCampaign
default CompletableFuture<PauseCampaignResponse> pauseCampaign(PauseCampaignRequest pauseCampaignRequest)
Pauses a campaign for the specified Amazon Connect account.
- Parameters:
pauseCampaignRequest- The request for PauseCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPauseCampaignRequest.builder()- Parameters:
pauseCampaignRequest- AConsumerthat will call methods onPauseCampaignRequest.Builderto create a request. The request for PauseCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putConnectInstanceIntegration
default CompletableFuture<PutConnectInstanceIntegrationResponse> putConnectInstanceIntegration(PutConnectInstanceIntegrationRequest putConnectInstanceIntegrationRequest)
Put or update the integration for the specified Amazon Connect instance.
- Parameters:
putConnectInstanceIntegrationRequest- The request for PutConnectInstanceIntegration API.- Returns:
- A Java Future containing the result of the PutConnectInstanceIntegration 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putConnectInstanceIntegration
default CompletableFuture<PutConnectInstanceIntegrationResponse> putConnectInstanceIntegration(Consumer<PutConnectInstanceIntegrationRequest.Builder> putConnectInstanceIntegrationRequest)
Put or update the integration for the specified Amazon Connect instance.
This is a convenience which creates an instance of the
PutConnectInstanceIntegrationRequest.Builderavoiding the need to create one manually viaPutConnectInstanceIntegrationRequest.builder()- Parameters:
putConnectInstanceIntegrationRequest- AConsumerthat will call methods onPutConnectInstanceIntegrationRequest.Builderto create a request. The request for PutConnectInstanceIntegration API.- Returns:
- A Java Future containing the result of the PutConnectInstanceIntegration 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putOutboundRequestBatch
default CompletableFuture<PutOutboundRequestBatchResponse> putOutboundRequestBatch(PutOutboundRequestBatchRequest putOutboundRequestBatchRequest)
Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.
- Parameters:
putOutboundRequestBatchRequest- The request for PutOutboundRequestBatch API.- Returns:
- A Java Future containing the result of the PutOutboundRequestBatch 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putOutboundRequestBatch
default CompletableFuture<PutOutboundRequestBatchResponse> putOutboundRequestBatch(Consumer<PutOutboundRequestBatchRequest.Builder> putOutboundRequestBatchRequest)
Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the
PutOutboundRequestBatchRequest.Builderavoiding the need to create one manually viaPutOutboundRequestBatchRequest.builder()- Parameters:
putOutboundRequestBatchRequest- AConsumerthat will call methods onPutOutboundRequestBatchRequest.Builderto create a request. The request for PutOutboundRequestBatch API.- Returns:
- A Java Future containing the result of the PutOutboundRequestBatch 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putProfileOutboundRequestBatch
default CompletableFuture<PutProfileOutboundRequestBatchResponse> putProfileOutboundRequestBatch(PutProfileOutboundRequestBatchRequest putProfileOutboundRequestBatchRequest)
Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.
- Parameters:
putProfileOutboundRequestBatchRequest- The request for PutProfileOutboundRequestBatch API- Returns:
- A Java Future containing the result of the PutProfileOutboundRequestBatch 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putProfileOutboundRequestBatch
default CompletableFuture<PutProfileOutboundRequestBatchResponse> putProfileOutboundRequestBatch(Consumer<PutProfileOutboundRequestBatchRequest.Builder> putProfileOutboundRequestBatchRequest)
Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.
This is a convenience which creates an instance of the
PutProfileOutboundRequestBatchRequest.Builderavoiding the need to create one manually viaPutProfileOutboundRequestBatchRequest.builder()- Parameters:
putProfileOutboundRequestBatchRequest- AConsumerthat will call methods onPutProfileOutboundRequestBatchRequest.Builderto create a request. The request for PutProfileOutboundRequestBatch API- Returns:
- A Java Future containing the result of the PutProfileOutboundRequestBatch 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
resumeCampaign
default CompletableFuture<ResumeCampaignResponse> resumeCampaign(ResumeCampaignRequest resumeCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
- Parameters:
resumeCampaignRequest- The request for ResumeCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaResumeCampaignRequest.builder()- Parameters:
resumeCampaignRequest- AConsumerthat will call methods onResumeCampaignRequest.Builderto create a request. The request for ResumeCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startCampaign
default CompletableFuture<StartCampaignResponse> startCampaign(StartCampaignRequest startCampaignRequest)
Starts a campaign for the specified Amazon Connect account.
- Parameters:
startCampaignRequest- The request for StartCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartCampaignRequest.builder()- Parameters:
startCampaignRequest- AConsumerthat will call methods onStartCampaignRequest.Builderto create a request. The request for StartCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartInstanceOnboardingJobRequest.builder()- Parameters:
startInstanceOnboardingJobRequest- AConsumerthat will call methods onStartInstanceOnboardingJobRequest.Builderto 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
stopCampaign
default CompletableFuture<StopCampaignResponse> stopCampaign(StopCampaignRequest stopCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
- Parameters:
stopCampaignRequest- The request for StopCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStopCampaignRequest.builder()- Parameters:
stopCampaignRequest- AConsumerthat will call methods onStopCampaignRequest.Builderto create a request. The request for StopCampaign API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tag a resource.
- Parameters:
tagResourceRequest- The request for TagResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. The request for TagResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Untag a resource.
- Parameters:
untagResourceRequest- The request for UntagResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untag a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. The request for UntagResource API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignChannelSubtypeConfig
default CompletableFuture<UpdateCampaignChannelSubtypeConfigResponse> updateCampaignChannelSubtypeConfig(UpdateCampaignChannelSubtypeConfigRequest updateCampaignChannelSubtypeConfigRequest)
Updates the channel subtype config of a campaign. This API is idempotent.
- Parameters:
updateCampaignChannelSubtypeConfigRequest- The request for UpdateCampaignChannelSubtypeConfig API.- Returns:
- A Java Future containing the result of the UpdateCampaignChannelSubtypeConfig 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignChannelSubtypeConfig
default CompletableFuture<UpdateCampaignChannelSubtypeConfigResponse> updateCampaignChannelSubtypeConfig(Consumer<UpdateCampaignChannelSubtypeConfigRequest.Builder> updateCampaignChannelSubtypeConfigRequest)
Updates the channel subtype config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignChannelSubtypeConfigRequest.Builderavoiding the need to create one manually viaUpdateCampaignChannelSubtypeConfigRequest.builder()- Parameters:
updateCampaignChannelSubtypeConfigRequest- AConsumerthat will call methods onUpdateCampaignChannelSubtypeConfigRequest.Builderto create a request. The request for UpdateCampaignChannelSubtypeConfig API.- Returns:
- A Java Future containing the result of the UpdateCampaignChannelSubtypeConfig 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignCommunicationLimits
default CompletableFuture<UpdateCampaignCommunicationLimitsResponse> updateCampaignCommunicationLimits(UpdateCampaignCommunicationLimitsRequest updateCampaignCommunicationLimitsRequest)
Updates the communication limits config for a campaign. This API is idempotent.
- Parameters:
updateCampaignCommunicationLimitsRequest- The request for UpdateCampaignCommunicationLimits API.- Returns:
- A Java Future containing the result of the UpdateCampaignCommunicationLimits 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignCommunicationLimits
default CompletableFuture<UpdateCampaignCommunicationLimitsResponse> updateCampaignCommunicationLimits(Consumer<UpdateCampaignCommunicationLimitsRequest.Builder> updateCampaignCommunicationLimitsRequest)
Updates the communication limits config for a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignCommunicationLimitsRequest.Builderavoiding the need to create one manually viaUpdateCampaignCommunicationLimitsRequest.builder()- Parameters:
updateCampaignCommunicationLimitsRequest- AConsumerthat will call methods onUpdateCampaignCommunicationLimitsRequest.Builderto create a request. The request for UpdateCampaignCommunicationLimits API.- Returns:
- A Java Future containing the result of the UpdateCampaignCommunicationLimits 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignCommunicationTime
default CompletableFuture<UpdateCampaignCommunicationTimeResponse> updateCampaignCommunicationTime(UpdateCampaignCommunicationTimeRequest updateCampaignCommunicationTimeRequest)
Updates the communication time config for a campaign. This API is idempotent.
- Parameters:
updateCampaignCommunicationTimeRequest- The request for UpdateCampaignCommunicationTime API.- Returns:
- A Java Future containing the result of the UpdateCampaignCommunicationTime 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignCommunicationTime
default CompletableFuture<UpdateCampaignCommunicationTimeResponse> updateCampaignCommunicationTime(Consumer<UpdateCampaignCommunicationTimeRequest.Builder> updateCampaignCommunicationTimeRequest)
Updates the communication time config for a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignCommunicationTimeRequest.Builderavoiding the need to create one manually viaUpdateCampaignCommunicationTimeRequest.builder()- Parameters:
updateCampaignCommunicationTimeRequest- AConsumerthat will call methods onUpdateCampaignCommunicationTimeRequest.Builderto create a request. The request for UpdateCampaignCommunicationTime API.- Returns:
- A Java Future containing the result of the UpdateCampaignCommunicationTime 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignFlowAssociation
default CompletableFuture<UpdateCampaignFlowAssociationResponse> updateCampaignFlowAssociation(UpdateCampaignFlowAssociationRequest updateCampaignFlowAssociationRequest)
Updates the campaign flow associated with a campaign. This API is idempotent.
- Parameters:
updateCampaignFlowAssociationRequest- The request for UpdateCampaignFlowAssociation API.- Returns:
- A Java Future containing the result of the UpdateCampaignFlowAssociation 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignFlowAssociation
default CompletableFuture<UpdateCampaignFlowAssociationResponse> updateCampaignFlowAssociation(Consumer<UpdateCampaignFlowAssociationRequest.Builder> updateCampaignFlowAssociationRequest)
Updates the campaign flow associated with a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignFlowAssociationRequest.Builderavoiding the need to create one manually viaUpdateCampaignFlowAssociationRequest.builder()- Parameters:
updateCampaignFlowAssociationRequest- AConsumerthat will call methods onUpdateCampaignFlowAssociationRequest.Builderto create a request. The request for UpdateCampaignFlowAssociation API.- Returns:
- A Java Future containing the result of the UpdateCampaignFlowAssociation 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignName
default CompletableFuture<UpdateCampaignNameResponse> updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest)
Updates the name of a campaign. This API is idempotent.
- Parameters:
updateCampaignNameRequest- The request for UpdateCampaignName API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateCampaignNameRequest.builder()- Parameters:
updateCampaignNameRequest- AConsumerthat will call methods onUpdateCampaignNameRequest.Builderto create a request. The request for UpdateCampaignName API.- 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.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignSchedule
default CompletableFuture<UpdateCampaignScheduleResponse> updateCampaignSchedule(UpdateCampaignScheduleRequest updateCampaignScheduleRequest)
Updates the schedule for a campaign. This API is idempotent.
- Parameters:
updateCampaignScheduleRequest- The request for UpdateCampaignSchedule API.- Returns:
- A Java Future containing the result of the UpdateCampaignSchedule 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignSchedule
default CompletableFuture<UpdateCampaignScheduleResponse> updateCampaignSchedule(Consumer<UpdateCampaignScheduleRequest.Builder> updateCampaignScheduleRequest)
Updates the schedule for a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignScheduleRequest.Builderavoiding the need to create one manually viaUpdateCampaignScheduleRequest.builder()- Parameters:
updateCampaignScheduleRequest- AConsumerthat will call methods onUpdateCampaignScheduleRequest.Builderto create a request. The request for UpdateCampaignSchedule API.- Returns:
- A Java Future containing the result of the UpdateCampaignSchedule 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignSource
default CompletableFuture<UpdateCampaignSourceResponse> updateCampaignSource(UpdateCampaignSourceRequest updateCampaignSourceRequest)
Updates the campaign source with a campaign. This API is idempotent.
- Parameters:
updateCampaignSourceRequest- The request for UpdateCampaignSource API.- Returns:
- A Java Future containing the result of the UpdateCampaignSource 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateCampaignSource
default CompletableFuture<UpdateCampaignSourceResponse> updateCampaignSource(Consumer<UpdateCampaignSourceRequest.Builder> updateCampaignSourceRequest)
Updates the campaign source with a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignSourceRequest.Builderavoiding the need to create one manually viaUpdateCampaignSourceRequest.builder()- Parameters:
updateCampaignSourceRequest- AConsumerthat will call methods onUpdateCampaignSourceRequest.Builderto create a request. The request for UpdateCampaignSource API.- Returns:
- A Java Future containing the result of the UpdateCampaignSource 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectCampaignsV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default ConnectCampaignsV2ServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static ConnectCampaignsV2AsyncClient create()
Create aConnectCampaignsV2AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ConnectCampaignsV2AsyncClientBuilder builder()
Create a builder that can be used to configure and create aConnectCampaignsV2AsyncClient.
-
-