@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectCampaignsAsyncClient extends AwsClient
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 |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
createCampaignRequest - The request for Create Campaign API.default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the CreateCampaignRequest.Builder avoiding the need to
create one manually via CreateCampaignRequest.builder()
createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.
The request for Create Campaign API.default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Deletes a campaign from the specified Amazon Connect account.
deleteCampaignRequest - DeleteCampaignRequestdefault CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)
Deletes a campaign from the specified Amazon Connect account.
This is a convenience which creates an instance of the DeleteCampaignRequest.Builder avoiding the need to
create one manually via DeleteCampaignRequest.builder()
deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.
DeleteCampaignRequestdefault CompletableFuture<DeleteConnectInstanceConfigResponse> deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest)
Deletes a connect instance config from the specified AWS account.
deleteConnectInstanceConfigRequest - DeleteCampaignRequestdefault CompletableFuture<DeleteConnectInstanceConfigResponse> deleteConnectInstanceConfig(Consumer<DeleteConnectInstanceConfigRequest.Builder> deleteConnectInstanceConfigRequest)
Deletes a connect instance config from the specified AWS account.
This is a convenience which creates an instance of the DeleteConnectInstanceConfigRequest.Builder
avoiding the need to create one manually via DeleteConnectInstanceConfigRequest.builder()
deleteConnectInstanceConfigRequest - A Consumer that will call methods on DeleteConnectInstanceConfigRequest.Builder to create
a request. DeleteCampaignRequestdefault CompletableFuture<DeleteInstanceOnboardingJobResponse> deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest)
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
deleteInstanceOnboardingJobRequest - The request for DeleteInstanceOnboardingJob API.default CompletableFuture<DeleteInstanceOnboardingJobResponse> deleteInstanceOnboardingJob(Consumer<DeleteInstanceOnboardingJobRequest.Builder> deleteInstanceOnboardingJobRequest)
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
This is a convenience which creates an instance of the DeleteInstanceOnboardingJobRequest.Builder
avoiding the need to create one manually via DeleteInstanceOnboardingJobRequest.builder()
deleteInstanceOnboardingJobRequest - A Consumer that will call methods on DeleteInstanceOnboardingJobRequest.Builder to create
a request. The request for DeleteInstanceOnboardingJob API.default CompletableFuture<DescribeCampaignResponse> describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the specific campaign.
describeCampaignRequest - DescribeCampaignRequestsdefault CompletableFuture<DescribeCampaignResponse> describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the specific campaign.
This is a convenience which creates an instance of the DescribeCampaignRequest.Builder avoiding the need
to create one manually via DescribeCampaignRequest.builder()
describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request.
DescribeCampaignRequestsdefault CompletableFuture<GetCampaignStateResponse> getCampaignState(GetCampaignStateRequest getCampaignStateRequest)
Get state of a campaign for the specified Amazon Connect account.
getCampaignStateRequest - GetCampaignStateRequestdefault CompletableFuture<GetCampaignStateResponse> getCampaignState(Consumer<GetCampaignStateRequest.Builder> getCampaignStateRequest)
Get state of a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the GetCampaignStateRequest.Builder avoiding the need
to create one manually via GetCampaignStateRequest.builder()
getCampaignStateRequest - A Consumer that will call methods on GetCampaignStateRequest.Builder to create a request.
GetCampaignStateRequestdefault CompletableFuture<GetCampaignStateBatchResponse> getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest)
Get state of campaigns for the specified Amazon Connect account.
getCampaignStateBatchRequest - GetCampaignStateBatchRequestdefault CompletableFuture<GetCampaignStateBatchResponse> getCampaignStateBatch(Consumer<GetCampaignStateBatchRequest.Builder> getCampaignStateBatchRequest)
Get state of campaigns for the specified Amazon Connect account.
This is a convenience which creates an instance of the GetCampaignStateBatchRequest.Builder avoiding the
need to create one manually via GetCampaignStateBatchRequest.builder()
getCampaignStateBatchRequest - A Consumer that will call methods on GetCampaignStateBatchRequest.Builder to create a
request. GetCampaignStateBatchRequestdefault CompletableFuture<GetConnectInstanceConfigResponse> getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest)
Get the specific Connect instance config.
getConnectInstanceConfigRequest - GetConnectInstanceConfigRequestdefault CompletableFuture<GetConnectInstanceConfigResponse> getConnectInstanceConfig(Consumer<GetConnectInstanceConfigRequest.Builder> getConnectInstanceConfigRequest)
Get the specific Connect instance config.
This is a convenience which creates an instance of the GetConnectInstanceConfigRequest.Builder avoiding
the need to create one manually via GetConnectInstanceConfigRequest.builder()
getConnectInstanceConfigRequest - A Consumer that will call methods on GetConnectInstanceConfigRequest.Builder to create a
request. GetConnectInstanceConfigRequestdefault CompletableFuture<GetInstanceOnboardingJobStatusResponse> getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest)
Get the specific instance onboarding job status.
getInstanceOnboardingJobStatusRequest - GetInstanceOnboardingJobStatusRequestdefault CompletableFuture<GetInstanceOnboardingJobStatusResponse> getInstanceOnboardingJobStatus(Consumer<GetInstanceOnboardingJobStatusRequest.Builder> getInstanceOnboardingJobStatusRequest)
Get the specific instance onboarding job status.
This is a convenience which creates an instance of the GetInstanceOnboardingJobStatusRequest.Builder
avoiding the need to create one manually via GetInstanceOnboardingJobStatusRequest.builder()
getInstanceOnboardingJobStatusRequest - A Consumer that will call methods on GetInstanceOnboardingJobStatusRequest.Builder to
create a request. GetInstanceOnboardingJobStatusRequestdefault CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
listCampaignsRequest - ListCampaignsRequestdefault CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Provides summary information about the campaigns under the specified Amazon Connect account.
This is a convenience which creates an instance of the ListCampaignsRequest.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
ListCampaignsRequestdefault ListCampaignsPublisher listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.
listCampaignsRequest - ListCampaignsRequestdefault ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connectcampaigns.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.connectcampaigns.model.ListCampaignsRequest)
operation.
This is a convenience which creates an instance of the ListCampaignsRequest.Builder avoiding the need to
create one manually via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
ListCampaignsRequestdefault CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a resource.
listTagsForResourceRequest - ListTagsForResourcedefault CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourcedefault CompletableFuture<PauseCampaignResponse> pauseCampaign(PauseCampaignRequest pauseCampaignRequest)
Pauses a campaign for the specified Amazon Connect account.
pauseCampaignRequest - PauseCampaignRequestdefault CompletableFuture<PauseCampaignResponse> pauseCampaign(Consumer<PauseCampaignRequest.Builder> pauseCampaignRequest)
Pauses a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the PauseCampaignRequest.Builder avoiding the need to
create one manually via PauseCampaignRequest.builder()
pauseCampaignRequest - A Consumer that will call methods on PauseCampaignRequest.Builder to create a request.
PauseCampaignRequestdefault CompletableFuture<PutDialRequestBatchResponse> putDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest)
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
putDialRequestBatchRequest - PutDialRequestBatchRequestdefault CompletableFuture<PutDialRequestBatchResponse> putDialRequestBatch(Consumer<PutDialRequestBatchRequest.Builder> putDialRequestBatchRequest)
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
This is a convenience which creates an instance of the PutDialRequestBatchRequest.Builder avoiding the
need to create one manually via PutDialRequestBatchRequest.builder()
putDialRequestBatchRequest - A Consumer that will call methods on PutDialRequestBatchRequest.Builder to create a
request. PutDialRequestBatchRequestdefault CompletableFuture<ResumeCampaignResponse> resumeCampaign(ResumeCampaignRequest resumeCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
resumeCampaignRequest - ResumeCampaignRequestdefault CompletableFuture<ResumeCampaignResponse> resumeCampaign(Consumer<ResumeCampaignRequest.Builder> resumeCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the ResumeCampaignRequest.Builder avoiding the need to
create one manually via ResumeCampaignRequest.builder()
resumeCampaignRequest - A Consumer that will call methods on ResumeCampaignRequest.Builder to create a request.
ResumeCampaignRequestdefault CompletableFuture<StartCampaignResponse> startCampaign(StartCampaignRequest startCampaignRequest)
Starts a campaign for the specified Amazon Connect account.
startCampaignRequest - StartCampaignRequestdefault CompletableFuture<StartCampaignResponse> startCampaign(Consumer<StartCampaignRequest.Builder> startCampaignRequest)
Starts a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the StartCampaignRequest.Builder avoiding the need to
create one manually via StartCampaignRequest.builder()
startCampaignRequest - A Consumer that will call methods on StartCampaignRequest.Builder to create a request.
StartCampaignRequestdefault CompletableFuture<StartInstanceOnboardingJobResponse> startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest)
Onboard the specific Amazon Connect instance to Connect Campaigns.
startInstanceOnboardingJobRequest - The request for StartInstanceOnboardingJob API.default CompletableFuture<StartInstanceOnboardingJobResponse> startInstanceOnboardingJob(Consumer<StartInstanceOnboardingJobRequest.Builder> startInstanceOnboardingJobRequest)
Onboard the specific Amazon Connect instance to Connect Campaigns.
This is a convenience which creates an instance of the StartInstanceOnboardingJobRequest.Builder avoiding
the need to create one manually via StartInstanceOnboardingJobRequest.builder()
startInstanceOnboardingJobRequest - A Consumer that will call methods on StartInstanceOnboardingJobRequest.Builder to create a
request. The request for StartInstanceOnboardingJob API.default CompletableFuture<StopCampaignResponse> stopCampaign(StopCampaignRequest stopCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
stopCampaignRequest - StopCampaignRequestdefault CompletableFuture<StopCampaignResponse> stopCampaign(Consumer<StopCampaignRequest.Builder> stopCampaignRequest)
Stops a campaign for the specified Amazon Connect account.
This is a convenience which creates an instance of the StopCampaignRequest.Builder avoiding the need to
create one manually via StopCampaignRequest.builder()
stopCampaignRequest - A Consumer that will call methods on StopCampaignRequest.Builder to create a request.
StopCampaignRequestdefault CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tag a resource.
tagResourceRequest - TagResourceRequestdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
TagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Untag a resource.
untagResourceRequest - UntagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untag a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
UntagResourceRequestdefault CompletableFuture<UpdateCampaignDialerConfigResponse> updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest)
Updates the dialer config of a campaign. This API is idempotent.
updateCampaignDialerConfigRequest - UpdateCampaignDialerConfigRequestdefault CompletableFuture<UpdateCampaignDialerConfigResponse> updateCampaignDialerConfig(Consumer<UpdateCampaignDialerConfigRequest.Builder> updateCampaignDialerConfigRequest)
Updates the dialer config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the UpdateCampaignDialerConfigRequest.Builder avoiding
the need to create one manually via UpdateCampaignDialerConfigRequest.builder()
updateCampaignDialerConfigRequest - A Consumer that will call methods on UpdateCampaignDialerConfigRequest.Builder to create a
request. UpdateCampaignDialerConfigRequestdefault CompletableFuture<UpdateCampaignNameResponse> updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest)
Updates the name of a campaign. This API is idempotent.
updateCampaignNameRequest - UpdateCampaignNameRequestdefault CompletableFuture<UpdateCampaignNameResponse> updateCampaignName(Consumer<UpdateCampaignNameRequest.Builder> updateCampaignNameRequest)
Updates the name of a campaign. This API is idempotent.
This is a convenience which creates an instance of the UpdateCampaignNameRequest.Builder avoiding the
need to create one manually via UpdateCampaignNameRequest.builder()
updateCampaignNameRequest - A Consumer that will call methods on UpdateCampaignNameRequest.Builder to create a
request. UpdateCampaignNameRequestdefault CompletableFuture<UpdateCampaignOutboundCallConfigResponse> updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest)
Updates the outbound call config of a campaign. This API is idempotent.
updateCampaignOutboundCallConfigRequest - UpdateCampaignOutboundCallConfigRequestdefault CompletableFuture<UpdateCampaignOutboundCallConfigResponse> updateCampaignOutboundCallConfig(Consumer<UpdateCampaignOutboundCallConfigRequest.Builder> updateCampaignOutboundCallConfigRequest)
Updates the outbound call config of a campaign. This API is idempotent.
This is a convenience which creates an instance of the UpdateCampaignOutboundCallConfigRequest.Builder
avoiding the need to create one manually via UpdateCampaignOutboundCallConfigRequest.builder()
updateCampaignOutboundCallConfigRequest - A Consumer that will call methods on UpdateCampaignOutboundCallConfigRequest.Builder to
create a request. UpdateCampaignOutboundCallConfigRequestdefault ConnectCampaignsServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic ConnectCampaignsAsyncClient create()
ConnectCampaignsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ConnectCampaignsAsyncClientBuilder builder()
ConnectCampaignsAsyncClient.Copyright © 2023. All rights reserved.