@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCampaignsClient extends SdkClient
builder()
method.
Provide APIs to create and manage Amazon Connect Campaigns.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ConnectCampaignsClientBuilder |
builder()
Create a builder that can be used to configure and create a
ConnectCampaignsClient. |
static ConnectCampaignsClient |
create()
Create a
ConnectCampaignsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCampaignResponse |
createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
Creates a campaign for the specified Amazon Connect account.
|
default CreateCampaignResponse |
createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a campaign for the specified Amazon Connect account.
|
default DeleteCampaignResponse |
deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)
Deletes a campaign from the specified Amazon Connect account.
|
default DeleteCampaignResponse |
deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Deletes a campaign from the specified Amazon Connect account.
|
default DeleteConnectInstanceConfigResponse |
deleteConnectInstanceConfig(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest)
Deletes a connect instance config from the specified AWS account.
|
default DeleteConnectInstanceConfigResponse |
deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest)
Deletes a connect instance config from the specified AWS account.
|
default DeleteInstanceOnboardingJobResponse |
deleteInstanceOnboardingJob(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest)
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
|
default DeleteInstanceOnboardingJobResponse |
deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest)
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
|
default DescribeCampaignResponse |
describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the specific campaign.
|
default DescribeCampaignResponse |
describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the specific campaign.
|
default GetCampaignStateResponse |
getCampaignState(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest)
Get state of a campaign for the specified Amazon Connect account.
|
default GetCampaignStateResponse |
getCampaignState(GetCampaignStateRequest getCampaignStateRequest)
Get state of a campaign for the specified Amazon Connect account.
|
default GetCampaignStateBatchResponse |
getCampaignStateBatch(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest)
Get state of campaigns for the specified Amazon Connect account.
|
default GetCampaignStateBatchResponse |
getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest)
Get state of campaigns for the specified Amazon Connect account.
|
default GetConnectInstanceConfigResponse |
getConnectInstanceConfig(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest)
Get the specific Connect instance config.
|
default GetConnectInstanceConfigResponse |
getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest)
Get the specific Connect instance config.
|
default GetInstanceOnboardingJobStatusResponse |
getInstanceOnboardingJobStatus(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest)
Get the specific instance onboarding job status.
|
default GetInstanceOnboardingJobStatusResponse |
getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest)
Get the specific instance onboarding job status.
|
default ListCampaignsResponse |
listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
|
default ListCampaignsResponse |
listCampaigns(ListCampaignsRequest listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
|
default ListCampaignsIterable |
listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
|
default ListCampaignsIterable |
listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a resource.
|
default PauseCampaignResponse |
pauseCampaign(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest)
Pauses a campaign for the specified Amazon Connect account.
|
default PauseCampaignResponse |
pauseCampaign(PauseCampaignRequest pauseCampaignRequest)
Pauses a campaign for the specified Amazon Connect account.
|
default PutDialRequestBatchResponse |
putDialRequestBatch(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest)
Creates dials requests for the specified campaign Amazon Connect account.
|
default PutDialRequestBatchResponse |
putDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest)
Creates dials requests for the specified campaign Amazon Connect account.
|
default ResumeCampaignResponse |
resumeCampaign(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
|
default ResumeCampaignResponse |
resumeCampaign(ResumeCampaignRequest resumeCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
|
static ServiceMetadata |
serviceMetadata() |
default StartCampaignResponse |
startCampaign(Consumer<StartCampaignRequest.Builder> startCampaignRequest)
Starts a campaign for the specified Amazon Connect account.
|
default StartCampaignResponse |
startCampaign(StartCampaignRequest startCampaignRequest)
Starts a campaign for the specified Amazon Connect account.
|
default StartInstanceOnboardingJobResponse |
startInstanceOnboardingJob(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest)
Onboard the specific Amazon Connect instance to Connect Campaigns.
|
default StartInstanceOnboardingJobResponse |
startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest)
Onboard the specific Amazon Connect instance to Connect Campaigns.
|
default StopCampaignResponse |
stopCampaign(Consumer<StopCampaignRequest.Builder> stopCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
|
default StopCampaignResponse |
stopCampaign(StopCampaignRequest stopCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag a resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Tag a resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untag a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Untag a resource.
|
default UpdateCampaignDialerConfigResponse |
updateCampaignDialerConfig(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest)
Updates the dialer config of a campaign.
|
default UpdateCampaignDialerConfigResponse |
updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest)
Updates the dialer config of a campaign.
|
default UpdateCampaignNameResponse |
updateCampaignName(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest)
Updates the name of a campaign.
|
default UpdateCampaignNameResponse |
updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest)
Updates the name of a campaign.
|
default UpdateCampaignOutboundCallConfigResponse |
updateCampaignOutboundCallConfig(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest)
Updates the outbound call config of a campaign.
|
default UpdateCampaignOutboundCallConfigResponse |
updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest)
Updates the outbound call config of a campaign.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ConnectCampaignsClient create()
ConnectCampaignsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ConnectCampaignsClientBuilder builder()
ConnectCampaignsClient.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.
createCampaignRequest - The request for Create Campaign API.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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via CreateCampaignRequest.builder()
createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.
The request for Create Campaign API.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.AwsServiceExceptiondefault DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Deletes a campaign from the specified Amazon Connect account.
deleteCampaignRequest - DeleteCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeleteCampaignRequest.builder()
deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.
DeleteCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault DeleteConnectInstanceConfigResponse deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, InvalidStateException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Deletes a connect instance config from the specified AWS account.
deleteConnectInstanceConfigRequest - DeleteCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DeleteConnectInstanceConfigRequest.builder()
deleteConnectInstanceConfigRequest - A Consumer that will call methods on DeleteConnectInstanceConfigRequest.Builder to create
a request. DeleteCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.
deleteInstanceOnboardingJobRequest - The request for DeleteInstanceOnboardingJob API.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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DeleteInstanceOnboardingJobRequest.builder()
deleteInstanceOnboardingJobRequest - A Consumer that will call methods on DeleteInstanceOnboardingJobRequest.Builder to create
a request. The request for DeleteInstanceOnboardingJob API.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.AwsServiceExceptiondefault DescribeCampaignResponse describeCampaign(DescribeCampaignRequest describeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Describes the specific campaign.
describeCampaignRequest - DescribeCampaignRequestsInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeCampaignRequest.builder()
describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request.
DescribeCampaignRequestsInternalServerException - 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.AwsServiceExceptiondefault GetCampaignStateResponse getCampaignState(GetCampaignStateRequest getCampaignStateRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get state of a campaign for the specified Amazon Connect account.
getCampaignStateRequest - GetCampaignStateRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via GetCampaignStateRequest.builder()
getCampaignStateRequest - A Consumer that will call methods on GetCampaignStateRequest.Builder to create a request.
GetCampaignStateRequestInternalServerException - 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.AwsServiceExceptiondefault GetCampaignStateBatchResponse getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get state of campaigns for the specified Amazon Connect account.
getCampaignStateBatchRequest - GetCampaignStateBatchRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetCampaignStateBatchRequest.builder()
getCampaignStateBatchRequest - A Consumer that will call methods on GetCampaignStateBatchRequest.Builder to create a
request. GetCampaignStateBatchRequestInternalServerException - 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.AwsServiceExceptiondefault GetConnectInstanceConfigResponse getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get the specific Connect instance config.
getConnectInstanceConfigRequest - GetConnectInstanceConfigRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetConnectInstanceConfigRequest.builder()
getConnectInstanceConfigRequest - A Consumer that will call methods on GetConnectInstanceConfigRequest.Builder to create a
request. GetConnectInstanceConfigRequestInternalServerException - 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.AwsServiceExceptiondefault GetInstanceOnboardingJobStatusResponse getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Get the specific instance onboarding job status.
getInstanceOnboardingJobStatusRequest - GetInstanceOnboardingJobStatusRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via GetInstanceOnboardingJobStatusRequest.builder()
getInstanceOnboardingJobStatusRequest - A Consumer that will call methods on GetInstanceOnboardingJobStatusRequest.Builder to
create a request. GetInstanceOnboardingJobStatusRequestInternalServerException - 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.AwsServiceExceptiondefault ListCampaignsResponse listCampaigns(ListCampaignsRequest listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Provides summary information about the campaigns under the specified Amazon Connect account.
listCampaignsRequest - ListCampaignsRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
ListCampaignsRequestInternalServerException - 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.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Provides summary information about the campaigns under the specified Amazon Connect account.
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
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listCampaignsRequest - ListCampaignsRequestInternalServerException - 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.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(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 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
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
ListCampaignsRequestInternalServerException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
List tags for a resource.
listTagsForResourceRequest - ListTagsForResourceInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourceInternalServerException - 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.AwsServiceExceptiondefault PauseCampaignResponse pauseCampaign(PauseCampaignRequest pauseCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Pauses a campaign for the specified Amazon Connect account.
pauseCampaignRequest - PauseCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via PauseCampaignRequest.builder()
pauseCampaignRequest - A Consumer that will call methods on PauseCampaignRequest.Builder to create a request.
PauseCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.
putDialRequestBatchRequest - PutDialRequestBatchRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via PutDialRequestBatchRequest.builder()
putDialRequestBatchRequest - A Consumer that will call methods on PutDialRequestBatchRequest.Builder to create a
request. PutDialRequestBatchRequestInternalServerException - 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.AwsServiceExceptiondefault ResumeCampaignResponse resumeCampaign(ResumeCampaignRequest resumeCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Stops a campaign for the specified Amazon Connect account.
resumeCampaignRequest - ResumeCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ResumeCampaignRequest.builder()
resumeCampaignRequest - A Consumer that will call methods on ResumeCampaignRequest.Builder to create a request.
ResumeCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault StartCampaignResponse startCampaign(StartCampaignRequest startCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Starts a campaign for the specified Amazon Connect account.
startCampaignRequest - StartCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via StartCampaignRequest.builder()
startCampaignRequest - A Consumer that will call methods on StartCampaignRequest.Builder to create a request.
StartCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault StartInstanceOnboardingJobResponse startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Onboard the specific Amazon Connect instance to Connect Campaigns.
startInstanceOnboardingJobRequest - The request for StartInstanceOnboardingJob API.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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via StartInstanceOnboardingJobRequest.builder()
startInstanceOnboardingJobRequest - A Consumer that will call methods on StartInstanceOnboardingJobRequest.Builder to create a
request. The request for StartInstanceOnboardingJob API.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.AwsServiceExceptiondefault StopCampaignResponse stopCampaign(StopCampaignRequest stopCampaignRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, InvalidCampaignStateException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Stops a campaign for the specified Amazon Connect account.
stopCampaignRequest - StopCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via StopCampaignRequest.builder()
stopCampaignRequest - A Consumer that will call methods on StopCampaignRequest.Builder to create a request.
StopCampaignRequestInternalServerException - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Tag a resource.
tagResourceRequest - TagResourceRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
TagResourceRequestInternalServerException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ConnectCampaignsException
Untag a resource.
untagResourceRequest - UntagResourceRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
UntagResourceRequestInternalServerException - 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.AwsServiceExceptiondefault UpdateCampaignDialerConfigResponse updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the dialer config of a campaign. This API is idempotent.
updateCampaignDialerConfigRequest - UpdateCampaignDialerConfigRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via UpdateCampaignDialerConfigRequest.builder()
updateCampaignDialerConfigRequest - A Consumer that will call methods on UpdateCampaignDialerConfigRequest.Builder to create a
request. UpdateCampaignDialerConfigRequestInternalServerException - 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.AwsServiceExceptiondefault UpdateCampaignNameResponse updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ConflictException, AccessDeniedException, AwsServiceException, SdkClientException, ConnectCampaignsException
Updates the name of a campaign. This API is idempotent.
updateCampaignNameRequest - UpdateCampaignNameRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateCampaignNameRequest.builder()
updateCampaignNameRequest - A Consumer that will call methods on UpdateCampaignNameRequest.Builder to create a
request. UpdateCampaignNameRequestInternalServerException - 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.AwsServiceExceptiondefault 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.
updateCampaignOutboundCallConfigRequest - UpdateCampaignOutboundCallConfigRequestInternalServerException - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via UpdateCampaignOutboundCallConfigRequest.builder()
updateCampaignOutboundCallConfigRequest - A Consumer that will call methods on UpdateCampaignOutboundCallConfigRequest.Builder to
create a request. UpdateCampaignOutboundCallConfigRequestInternalServerException - 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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2023. All rights reserved.