Package software.amazon.awssdk.services.connectcampaigns

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 static builder() method.

Provide APIs to create and manage Amazon Connect Campaigns.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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)	This is a variant of listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest) operation.
default ListCampaignsIterable	listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)	This is a variant of listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest) operation.
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.
default ConnectCampaignsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

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.

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.Builder avoiding the need to create one manually via CreateCampaignRequest.builder()

Parameters:

createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request. The request for Create Campaign API.

Returns:

Result of the CreateCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteCampaignRequest.builder()

Parameters:

deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request. DeleteCampaignRequest

Returns:

Result of the DeleteCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteConnectInstanceConfigRequest.builder()

Parameters:

deleteConnectInstanceConfigRequest - A Consumer that will call methods on DeleteConnectInstanceConfigRequest.Builder to create a request. DeleteCampaignRequest

Returns:

Result of the DeleteConnectInstanceConfig operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteInstanceOnboardingJobRequest.builder()

Parameters:

deleteInstanceOnboardingJobRequest - A Consumer that will call methods on DeleteInstanceOnboardingJobRequest.Builder to create a request. The request for DeleteInstanceOnboardingJob API.

Returns:

Result of the DeleteInstanceOnboardingJob operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DescribeCampaignRequest.builder()

Parameters:

describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request. DescribeCampaignRequests

Returns:

Result of the DescribeCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetCampaignStateRequest.builder()

Parameters:

getCampaignStateRequest - A Consumer that will call methods on GetCampaignStateRequest.Builder to create a request. GetCampaignStateRequest

Returns:

Result of the GetCampaignState operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetCampaignStateBatchRequest.builder()

Parameters:

getCampaignStateBatchRequest - A Consumer that will call methods on GetCampaignStateBatchRequest.Builder to create a request. GetCampaignStateBatchRequest

Returns:

Result of the GetCampaignStateBatch operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetConnectInstanceConfigRequest.builder()

Parameters:

getConnectInstanceConfigRequest - A Consumer that will call methods on GetConnectInstanceConfigRequest.Builder to create a request. GetConnectInstanceConfigRequest

Returns:

Result of the GetConnectInstanceConfig operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetInstanceOnboardingJobStatusRequest.builder()

Parameters:

getInstanceOnboardingJobStatusRequest - A Consumer that will call methods on GetInstanceOnboardingJobStatusRequest.Builder to create a request. GetInstanceOnboardingJobStatusRequest

Returns:

Result of the GetInstanceOnboardingJobStatus operation returned by the service.

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.

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.Builder avoiding the need to create one manually via ListCampaignsRequest.builder()

Parameters:

listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request. ListCampaignsRequest

Returns:

Result of the ListCampaigns operation returned by the service.

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

 
 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.

Parameters:

listCampaignsRequest - ListCampaignsRequest

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

 
 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()

Parameters:

listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request. ListCampaignsRequest

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. ListTagsForResource

Returns:

Result of the ListTagsForResource operation returned by the service.

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.

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.Builder avoiding the need to create one manually via PauseCampaignRequest.builder()

Parameters:

pauseCampaignRequest - A Consumer that will call methods on PauseCampaignRequest.Builder to create a request. PauseCampaignRequest

Returns:

Result of the PauseCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via PutDialRequestBatchRequest.builder()

Parameters:

putDialRequestBatchRequest - A Consumer that will call methods on PutDialRequestBatchRequest.Builder to create a request. PutDialRequestBatchRequest

Returns:

Result of the PutDialRequestBatch operation returned by the service.

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.

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.Builder avoiding the need to create one manually via ResumeCampaignRequest.builder()

Parameters:

resumeCampaignRequest - A Consumer that will call methods on ResumeCampaignRequest.Builder to create a request. ResumeCampaignRequest

Returns:

Result of the ResumeCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via StartCampaignRequest.builder()

Parameters:

startCampaignRequest - A Consumer that will call methods on StartCampaignRequest.Builder to create a request. StartCampaignRequest

Returns:

Result of the StartCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via StartInstanceOnboardingJobRequest.builder()

Parameters:

startInstanceOnboardingJobRequest - A Consumer that will call methods on StartInstanceOnboardingJobRequest.Builder to create a request. The request for StartInstanceOnboardingJob API.

Returns:

Result of the StartInstanceOnboardingJob operation returned by the service.

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.

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.Builder avoiding the need to create one manually via StopCampaignRequest.builder()

Parameters:

stopCampaignRequest - A Consumer that will call methods on StopCampaignRequest.Builder to create a request. StopCampaignRequest

Returns:

Result of the StopCampaign operation returned by the service.

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.

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.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. TagResourceRequest

Returns:

Result of the TagResource operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. UntagResourceRequest

Returns:

Result of the UntagResource operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateCampaignDialerConfigRequest.builder()

Parameters:

updateCampaignDialerConfigRequest - A Consumer that will call methods on UpdateCampaignDialerConfigRequest.Builder to create a request. UpdateCampaignDialerConfigRequest

Returns:

Result of the UpdateCampaignDialerConfig operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateCampaignNameRequest.builder()

Parameters:

updateCampaignNameRequest - A Consumer that will call methods on UpdateCampaignNameRequest.Builder to create a request. UpdateCampaignNameRequest

Returns:

Result of the UpdateCampaignName operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateCampaignOutboundCallConfigRequest.builder()

Parameters:

updateCampaignOutboundCallConfigRequest - A Consumer that will call methods on UpdateCampaignOutboundCallConfigRequest.Builder to create a request. UpdateCampaignOutboundCallConfigRequest

Returns:

Result of the UpdateCampaignOutboundCallConfig operation returned by the service.

See Also:

• AWS API Documentation

create

static ConnectCampaignsClient create()

Create a ConnectCampaignsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ConnectCampaignsClientBuilder builder()

Create a builder that can be used to configure and create a ConnectCampaignsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ConnectCampaignsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration