Interface ConnectCampaignsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCampaignsClient extends AwsClient
Service client for accessing AmazonConnectCampaignService. This can be created using the staticbuilder()method.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
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ConnectCampaignsClientBuilderbuilder()Create a builder that can be used to configure and create aConnectCampaignsClient.static ConnectCampaignsClientcreate()Create aConnectCampaignsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateCampaignResponsecreateCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)Creates a campaign for the specified Amazon Connect account.default CreateCampaignResponsecreateCampaign(CreateCampaignRequest createCampaignRequest)Creates a campaign for the specified Amazon Connect account.default DeleteCampaignResponsedeleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)Deletes a campaign from the specified Amazon Connect account.default DeleteCampaignResponsedeleteCampaign(DeleteCampaignRequest deleteCampaignRequest)Deletes a campaign from the specified Amazon Connect account.default DeleteConnectInstanceConfigResponsedeleteConnectInstanceConfig(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest)Deletes a connect instance config from the specified AWS account.default DeleteConnectInstanceConfigResponsedeleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest)Deletes a connect instance config from the specified AWS account.default DeleteInstanceOnboardingJobResponsedeleteInstanceOnboardingJob(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest)Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.default DeleteInstanceOnboardingJobResponsedeleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest)Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.default DescribeCampaignResponsedescribeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)Describes the specific campaign.default DescribeCampaignResponsedescribeCampaign(DescribeCampaignRequest describeCampaignRequest)Describes the specific campaign.default GetCampaignStateResponsegetCampaignState(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest)Get state of a campaign for the specified Amazon Connect account.default GetCampaignStateResponsegetCampaignState(GetCampaignStateRequest getCampaignStateRequest)Get state of a campaign for the specified Amazon Connect account.default GetCampaignStateBatchResponsegetCampaignStateBatch(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest)Get state of campaigns for the specified Amazon Connect account.default GetCampaignStateBatchResponsegetCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest)Get state of campaigns for the specified Amazon Connect account.default GetConnectInstanceConfigResponsegetConnectInstanceConfig(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest)Get the specific Connect instance config.default GetConnectInstanceConfigResponsegetConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest)Get the specific Connect instance config.default GetInstanceOnboardingJobStatusResponsegetInstanceOnboardingJobStatus(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest)Get the specific instance onboarding job status.default GetInstanceOnboardingJobStatusResponsegetInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest)Get the specific instance onboarding job status.default ListCampaignsResponselistCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)Provides summary information about the campaigns under the specified Amazon Connect account.default ListCampaignsResponselistCampaigns(ListCampaignsRequest listCampaignsRequest)Provides summary information about the campaigns under the specified Amazon Connect account.default ListCampaignsIterablelistCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)This is a variant oflistCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)operation.default ListCampaignsIterablelistCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)This is a variant oflistCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)List tags for a resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)List tags for a resource.default PauseCampaignResponsepauseCampaign(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest)Pauses a campaign for the specified Amazon Connect account.default PauseCampaignResponsepauseCampaign(PauseCampaignRequest pauseCampaignRequest)Pauses a campaign for the specified Amazon Connect account.default PutDialRequestBatchResponseputDialRequestBatch(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest)Creates dials requests for the specified campaign Amazon Connect account.default PutDialRequestBatchResponseputDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest)Creates dials requests for the specified campaign Amazon Connect account.default ResumeCampaignResponseresumeCampaign(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest)Stops a campaign for the specified Amazon Connect account.default ResumeCampaignResponseresumeCampaign(ResumeCampaignRequest resumeCampaignRequest)Stops a campaign for the specified Amazon Connect account.default ConnectCampaignsServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartCampaignResponsestartCampaign(Consumer<StartCampaignRequest.Builder> startCampaignRequest)Starts a campaign for the specified Amazon Connect account.default StartCampaignResponsestartCampaign(StartCampaignRequest startCampaignRequest)Starts a campaign for the specified Amazon Connect account.default StartInstanceOnboardingJobResponsestartInstanceOnboardingJob(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest)Onboard the specific Amazon Connect instance to Connect Campaigns.default StartInstanceOnboardingJobResponsestartInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest)Onboard the specific Amazon Connect instance to Connect Campaigns.default StopCampaignResponsestopCampaign(Consumer<StopCampaignRequest.Builder> stopCampaignRequest)Stops a campaign for the specified Amazon Connect account.default StopCampaignResponsestopCampaign(StopCampaignRequest stopCampaignRequest)Stops a campaign for the specified Amazon Connect account.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Tag a resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Tag a resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Untag a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Untag a resource.default UpdateCampaignDialerConfigResponseupdateCampaignDialerConfig(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest)Updates the dialer config of a campaign.default UpdateCampaignDialerConfigResponseupdateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest)Updates the dialer config of a campaign.default UpdateCampaignNameResponseupdateCampaignName(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest)Updates the name of a campaign.default UpdateCampaignNameResponseupdateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest)Updates the name of a campaign.default UpdateCampaignOutboundCallConfigResponseupdateCampaignOutboundCallConfig(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest)Updates the outbound call config of a campaign.default UpdateCampaignOutboundCallConfigResponseupdateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest)Updates the outbound call config of a campaign.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field 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 CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
- Parameters:
createCampaignRequest- The request for Create Campaign API.- Returns:
- Result of the CreateCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createCampaign
default CreateCampaignResponse createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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 Create Campaign API.- Returns:
- Result of the CreateCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Deletes a campaign from the specified Amazon Connect account.
- Parameters:
deleteCampaignRequest- DeleteCampaignRequest- Returns:
- Result of the DeleteCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. DeleteCampaignRequest- Returns:
- Result of the DeleteCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConnectInstanceConfig
default DeleteConnectInstanceConfigResponse deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, InvalidStateException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Deletes a connect instance config from the specified AWS account.
- Parameters:
deleteConnectInstanceConfigRequest- DeleteCampaignRequest- Returns:
- Result of the DeleteConnectInstanceConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.InvalidStateException- The request could not be processed because of conflict in the current state.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConnectInstanceConfig
default DeleteConnectInstanceConfigResponse deleteConnectInstanceConfig(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, InvalidStateException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. DeleteCampaignRequest- Returns:
- Result of the DeleteConnectInstanceConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.InvalidStateException- The request could not be processed because of conflict in the current state.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstanceOnboardingJob
default DeleteInstanceOnboardingJobResponse deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, InvalidStateException, AwsServiceException, SdkClientException, ConnectCampaignsException
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
- Parameters:
deleteInstanceOnboardingJobRequest- The request for DeleteInstanceOnboardingJob API.- Returns:
- Result of the DeleteInstanceOnboardingJob operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.InvalidStateException- The request could not be processed because of conflict in the current state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInstanceOnboardingJob
default DeleteInstanceOnboardingJobResponse deleteInstanceOnboardingJob(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, InvalidStateException, AwsServiceException, SdkClientException, ConnectCampaignsException
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:
- Result of the DeleteInstanceOnboardingJob operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.InvalidStateException- The request could not be processed because of conflict in the current state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCampaign
default DescribeCampaignResponse describeCampaign(DescribeCampaignRequest describeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Describes the specific campaign.
- Parameters:
describeCampaignRequest- DescribeCampaignRequests- Returns:
- Result of the DescribeCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCampaign
default DescribeCampaignResponse describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. DescribeCampaignRequests- Returns:
- Result of the DescribeCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getCampaignState
default GetCampaignStateResponse getCampaignState(GetCampaignStateRequest getCampaignStateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get state of a campaign for the specified Amazon Connect account.
- Parameters:
getCampaignStateRequest- GetCampaignStateRequest- Returns:
- Result of the GetCampaignState operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getCampaignState
default GetCampaignStateResponse getCampaignState(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. GetCampaignStateRequest- Returns:
- Result of the GetCampaignState operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getCampaignStateBatch
default GetCampaignStateBatchResponse getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get state of campaigns for the specified Amazon Connect account.
- Parameters:
getCampaignStateBatchRequest- GetCampaignStateBatchRequest- Returns:
- Result of the GetCampaignStateBatch operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getCampaignStateBatch
default GetCampaignStateBatchResponse getCampaignStateBatch(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. GetCampaignStateBatchRequest- Returns:
- Result of the GetCampaignStateBatch operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectInstanceConfig
default GetConnectInstanceConfigResponse getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get the specific Connect instance config.
- Parameters:
getConnectInstanceConfigRequest- GetConnectInstanceConfigRequest- Returns:
- Result of the GetConnectInstanceConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectInstanceConfig
default GetConnectInstanceConfigResponse getConnectInstanceConfig(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. GetConnectInstanceConfigRequest- Returns:
- Result of the GetConnectInstanceConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getInstanceOnboardingJobStatus
default GetInstanceOnboardingJobStatusResponse getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get the specific instance onboarding job status.
- Parameters:
getInstanceOnboardingJobStatusRequest- GetInstanceOnboardingJobStatusRequest- Returns:
- Result of the GetInstanceOnboardingJobStatus operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getInstanceOnboardingJobStatus
default GetInstanceOnboardingJobStatusResponse getInstanceOnboardingJobStatus(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. GetInstanceOnboardingJobStatusRequest- Returns:
- Result of the GetInstanceOnboardingJobStatus operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCampaigns
default ListCampaignsResponse listCampaigns(ListCampaignsRequest listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Provides summary information about the campaigns under the specified Amazon Connect account.
- Parameters:
listCampaignsRequest- ListCampaignsRequest- Returns:
- Result of the ListCampaigns operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCampaigns
default ListCampaignsResponse listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. ListCampaignsRequest- Returns:
- Result of the ListCampaigns operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCampaignsPaginator
default ListCampaignsIterable listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client .listCampaignsPaginator(request); for (software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)operation.- Parameters:
listCampaignsRequest- ListCampaignsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCampaignsPaginator
default ListCampaignsIterable listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
This is a variant of
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client .listCampaignsPaginator(request); for (software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.connectcampaigns.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. ListCampaignsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
List tags for a resource.
- Parameters:
listTagsForResourceRequest- ListTagsForResource- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. ListTagsForResource- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
pauseCampaign
default PauseCampaignResponse pauseCampaign(PauseCampaignRequest pauseCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Pauses a campaign for the specified Amazon Connect account.
- Parameters:
pauseCampaignRequest- PauseCampaignRequest- Returns:
- Result of the PauseCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
pauseCampaign
default PauseCampaignResponse pauseCampaign(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. PauseCampaignRequest- Returns:
- Result of the PauseCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putDialRequestBatch
default PutDialRequestBatchResponse putDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
- Parameters:
putDialRequestBatchRequest- PutDialRequestBatchRequest- Returns:
- Result of the PutDialRequestBatch operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putDialRequestBatch
default PutDialRequestBatchResponse putDialRequestBatch(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the
PutDialRequestBatchRequest.Builderavoiding the need to create one manually viaPutDialRequestBatchRequest.builder()- Parameters:
putDialRequestBatchRequest- AConsumerthat will call methods onPutDialRequestBatchRequest.Builderto create a request. PutDialRequestBatchRequest- Returns:
- Result of the PutDialRequestBatch operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resumeCampaign
default ResumeCampaignResponse resumeCampaign(ResumeCampaignRequest resumeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Stops a campaign for the specified Amazon Connect account.
- Parameters:
resumeCampaignRequest- ResumeCampaignRequest- Returns:
- Result of the ResumeCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resumeCampaign
default ResumeCampaignResponse resumeCampaign(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. ResumeCampaignRequest- Returns:
- Result of the ResumeCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startCampaign
default StartCampaignResponse startCampaign(StartCampaignRequest startCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Starts a campaign for the specified Amazon Connect account.
- Parameters:
startCampaignRequest- StartCampaignRequest- Returns:
- Result of the StartCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startCampaign
default StartCampaignResponse startCampaign(Consumer<StartCampaignRequest.Builder> startCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. StartCampaignRequest- Returns:
- Result of the StartCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startInstanceOnboardingJob
default StartInstanceOnboardingJobResponse startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Onboard the specific Amazon Connect instance to Connect Campaigns.
- Parameters:
startInstanceOnboardingJobRequest- The request for StartInstanceOnboardingJob API.- Returns:
- Result of the StartInstanceOnboardingJob operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startInstanceOnboardingJob
default StartInstanceOnboardingJobResponse startInstanceOnboardingJob(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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:
- Result of the StartInstanceOnboardingJob operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopCampaign
default StopCampaignResponse stopCampaign(StopCampaignRequest stopCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Stops a campaign for the specified Amazon Connect account.
- Parameters:
stopCampaignRequest- StopCampaignRequest- Returns:
- Result of the StopCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopCampaign
default StopCampaignResponse stopCampaign(Consumer<StopCampaignRequest.Builder> stopCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. StopCampaignRequest- Returns:
- Result of the StopCampaign operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException- The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Tag a resource.
- Parameters:
tagResourceRequest- TagResourceRequest- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. TagResourceRequest- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Untag a resource.
- Parameters:
untagResourceRequest- UntagResourceRequest- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. UntagResourceRequest- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignDialerConfig
default UpdateCampaignDialerConfigResponse updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the dialer config of a campaign. This API is idempotent.
- Parameters:
updateCampaignDialerConfigRequest- UpdateCampaignDialerConfigRequest- Returns:
- Result of the UpdateCampaignDialerConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignDialerConfig
default UpdateCampaignDialerConfigResponse updateCampaignDialerConfig(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the dialer config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignDialerConfigRequest.Builderavoiding the need to create one manually viaUpdateCampaignDialerConfigRequest.builder()- Parameters:
updateCampaignDialerConfigRequest- AConsumerthat will call methods onUpdateCampaignDialerConfigRequest.Builderto create a request. UpdateCampaignDialerConfigRequest- Returns:
- Result of the UpdateCampaignDialerConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignName
default UpdateCampaignNameResponse updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the name of a campaign. This API is idempotent.
- Parameters:
updateCampaignNameRequest- UpdateCampaignNameRequest- Returns:
- Result of the UpdateCampaignName operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignName
default UpdateCampaignNameResponse updateCampaignName(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
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. UpdateCampaignNameRequest- Returns:
- Result of the UpdateCampaignName operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignOutboundCallConfig
default UpdateCampaignOutboundCallConfigResponse updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the outbound call config of a campaign. This API is idempotent.
- Parameters:
updateCampaignOutboundCallConfigRequest- UpdateCampaignOutboundCallConfigRequest- Returns:
- Result of the UpdateCampaignOutboundCallConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCampaignOutboundCallConfig
default UpdateCampaignOutboundCallConfigResponse updateCampaignOutboundCallConfig(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the outbound call config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the
UpdateCampaignOutboundCallConfigRequest.Builderavoiding the need to create one manually viaUpdateCampaignOutboundCallConfigRequest.builder()- Parameters:
updateCampaignOutboundCallConfigRequest- AConsumerthat will call methods onUpdateCampaignOutboundCallConfigRequest.Builderto create a request. UpdateCampaignOutboundCallConfigRequest- Returns:
- Result of the UpdateCampaignOutboundCallConfig operation returned by the service.
- Throws:
InternalServerException- Request processing failed because of an error or failure with the service.ResourceNotFoundException- The specified resource was not found.ValidationException- The input fails to satisfy the constraints specified by an AWS service.ConflictException- The request could not be processed because of conflict in the current state of the resource.AccessDeniedException- You do not have sufficient access to perform this action.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectCampaignsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ConnectCampaignsClient create()
Create aConnectCampaignsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ConnectCampaignsClientBuilder builder()
Create a builder that can be used to configure and create aConnectCampaignsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ConnectCampaignsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-