com.amazonaws.services.connectcampaign

Class AmazonConnectCampaignClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.connectcampaign.AmazonConnectCampaignClient

All Implemented Interfaces:

AmazonConnectCampaign

Direct Known Subclasses:

AmazonConnectCampaignAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonConnectCampaignClient
extends AmazonWebServiceClient
implements AmazonConnectCampaign

Client for accessing AmazonConnectCampaignService. All service calls made using this client are blocking, and will not return until the service call completes.

Provide APIs to create and manage Amazon Connect Campaigns.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.connectcampaign.AmazonConnectCampaign

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonConnectCampaignClientBuilder	builder()
CreateCampaignResult	createCampaign(CreateCampaignRequest request) Creates a campaign for the specified Amazon Connect account.
DeleteCampaignResult	deleteCampaign(DeleteCampaignRequest request) Deletes a campaign from the specified Amazon Connect account.
DeleteConnectInstanceConfigResult	deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest request) Deletes a connect instance config from the specified AWS account.
DeleteInstanceOnboardingJobResult	deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest request) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
DescribeCampaignResult	describeCampaign(DescribeCampaignRequest request) Describes the specific campaign.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCampaignStateResult	getCampaignState(GetCampaignStateRequest request) Get state of a campaign for the specified Amazon Connect account.
GetCampaignStateBatchResult	getCampaignStateBatch(GetCampaignStateBatchRequest request) Get state of campaigns for the specified Amazon Connect account.
GetConnectInstanceConfigResult	getConnectInstanceConfig(GetConnectInstanceConfigRequest request) Get the specific Connect instance config.
GetInstanceOnboardingJobStatusResult	getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest request) Get the specific instance onboarding job status.
ListCampaignsResult	listCampaigns(ListCampaignsRequest request) Provides summary information about the campaigns under the specified Amazon Connect account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List tags for a resource.
PauseCampaignResult	pauseCampaign(PauseCampaignRequest request) Pauses a campaign for the specified Amazon Connect account.
PutDialRequestBatchResult	putDialRequestBatch(PutDialRequestBatchRequest request) Creates dials requests for the specified campaign Amazon Connect account.
ResumeCampaignResult	resumeCampaign(ResumeCampaignRequest request) Stops a campaign for the specified Amazon Connect account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCampaignResult	startCampaign(StartCampaignRequest request) Starts a campaign for the specified Amazon Connect account.
StartInstanceOnboardingJobResult	startInstanceOnboardingJob(StartInstanceOnboardingJobRequest request) Onboard the specific Amazon Connect instance to Connect Campaigns.
StopCampaignResult	stopCampaign(StopCampaignRequest request) Stops a campaign for the specified Amazon Connect account.
TagResourceResult	tagResource(TagResourceRequest request) Tag a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Untag a resource.
UpdateCampaignDialerConfigResult	updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest request) Updates the dialer config of a campaign.
UpdateCampaignNameResult	updateCampaignName(UpdateCampaignNameRequest request) Updates the name of a campaign.
UpdateCampaignOutboundCallConfigResult	updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest request) Updates the outbound call config of a campaign.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonConnectCampaignClientBuilder builder()

createCampaign

public CreateCampaignResult createCampaign(CreateCampaignRequest request)

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Specified by:

createCampaign in interface AmazonConnectCampaign

Parameters:

createCampaignRequest - The request for Create Campaign API.

Returns:

Result of the CreateCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

AccessDeniedException - You do not have sufficient access to perform this action.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteCampaign

public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)

Deletes a campaign from the specified Amazon Connect account.

Specified by:

deleteCampaign in interface AmazonConnectCampaign

Parameters:

deleteCampaignRequest - DeleteCampaignRequest

Returns:

Result of the DeleteCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

deleteConnectInstanceConfig

public DeleteConnectInstanceConfigResult deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest request)

Deletes a connect instance config from the specified AWS account.

Specified by:

deleteConnectInstanceConfig in interface AmazonConnectCampaign

Parameters:

deleteConnectInstanceConfigRequest - DeleteCampaignRequest

Returns:

Result of the DeleteConnectInstanceConfig operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidStateException - The request could not be processed because of conflict in the current state.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteInstanceOnboardingJob

public DeleteInstanceOnboardingJobResult deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest request)

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

Specified by:

deleteInstanceOnboardingJob in interface AmazonConnectCampaign

Parameters:

deleteInstanceOnboardingJobRequest - The request for DeleteInstanceOnboardingJob API.

Returns:

Result of the DeleteInstanceOnboardingJob operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidStateException - The request could not be processed because of conflict in the current state.

See Also:

AWS API Documentation

describeCampaign

public DescribeCampaignResult describeCampaign(DescribeCampaignRequest request)

Describes the specific campaign.

Specified by:

describeCampaign in interface AmazonConnectCampaign

Parameters:

describeCampaignRequest - DescribeCampaignRequests

Returns:

Result of the DescribeCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getCampaignState

public GetCampaignStateResult getCampaignState(GetCampaignStateRequest request)

Get state of a campaign for the specified Amazon Connect account.

Specified by:

getCampaignState in interface AmazonConnectCampaign

Parameters:

getCampaignStateRequest - GetCampaignStateRequest

Returns:

Result of the GetCampaignState operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getCampaignStateBatch

public GetCampaignStateBatchResult getCampaignStateBatch(GetCampaignStateBatchRequest request)

Get state of campaigns for the specified Amazon Connect account.

Specified by:

getCampaignStateBatch in interface AmazonConnectCampaign

Parameters:

getCampaignStateBatchRequest - GetCampaignStateBatchRequest

Returns:

Result of the GetCampaignStateBatch operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getConnectInstanceConfig

public GetConnectInstanceConfigResult getConnectInstanceConfig(GetConnectInstanceConfigRequest request)

Get the specific Connect instance config.

Specified by:

getConnectInstanceConfig in interface AmazonConnectCampaign

Parameters:

getConnectInstanceConfigRequest - GetConnectInstanceConfigRequest

Returns:

Result of the GetConnectInstanceConfig operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getInstanceOnboardingJobStatus

public GetInstanceOnboardingJobStatusResult getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest request)

Get the specific instance onboarding job status.

Specified by:

getInstanceOnboardingJobStatus in interface AmazonConnectCampaign

Parameters:

getInstanceOnboardingJobStatusRequest - GetInstanceOnboardingJobStatusRequest

Returns:

Result of the GetInstanceOnboardingJobStatus operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listCampaigns

public ListCampaignsResult listCampaigns(ListCampaignsRequest request)

Provides summary information about the campaigns under the specified Amazon Connect account.

Specified by:

listCampaigns in interface AmazonConnectCampaign

Parameters:

listCampaignsRequest - ListCampaignsRequest

Returns:

Result of the ListCampaigns operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List tags for a resource.

Specified by:

listTagsForResource in interface AmazonConnectCampaign

Parameters:

listTagsForResourceRequest - ListTagsForResource

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

pauseCampaign

public PauseCampaignResult pauseCampaign(PauseCampaignRequest request)

Pauses a campaign for the specified Amazon Connect account.

Specified by:

pauseCampaign in interface AmazonConnectCampaign

Parameters:

pauseCampaignRequest - PauseCampaignRequest

Returns:

Result of the PauseCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

putDialRequestBatch

public PutDialRequestBatchResult putDialRequestBatch(PutDialRequestBatchRequest request)

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

Specified by:

putDialRequestBatch in interface AmazonConnectCampaign

Parameters:

putDialRequestBatchRequest - PutDialRequestBatchRequest

Returns:

Result of the PutDialRequestBatch operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

resumeCampaign

public ResumeCampaignResult resumeCampaign(ResumeCampaignRequest request)

Stops a campaign for the specified Amazon Connect account.

Specified by:

resumeCampaign in interface AmazonConnectCampaign

Parameters:

resumeCampaignRequest - ResumeCampaignRequest

Returns:

Result of the ResumeCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

startCampaign

public StartCampaignResult startCampaign(StartCampaignRequest request)

Starts a campaign for the specified Amazon Connect account.

Specified by:

startCampaign in interface AmazonConnectCampaign

Parameters:

startCampaignRequest - StartCampaignRequest

Returns:

Result of the StartCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

startInstanceOnboardingJob

public StartInstanceOnboardingJobResult startInstanceOnboardingJob(StartInstanceOnboardingJobRequest request)

Onboard the specific Amazon Connect instance to Connect Campaigns.

Specified by:

startInstanceOnboardingJob in interface AmazonConnectCampaign

Parameters:

startInstanceOnboardingJobRequest - The request for StartInstanceOnboardingJob API.

Returns:

Result of the StartInstanceOnboardingJob operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

stopCampaign

public StopCampaignResult stopCampaign(StopCampaignRequest request)

Stops a campaign for the specified Amazon Connect account.

Specified by:

stopCampaign in interface AmazonConnectCampaign

Parameters:

stopCampaignRequest - StopCampaignRequest

Returns:

Result of the StopCampaign operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Tag a resource.

Specified by:

tagResource in interface AmazonConnectCampaign

Parameters:

tagResourceRequest - TagResourceRequest

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Untag a resource.

Specified by:

untagResource in interface AmazonConnectCampaign

Parameters:

untagResourceRequest - UntagResourceRequest

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateCampaignDialerConfig

public UpdateCampaignDialerConfigResult updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest request)

Updates the dialer config of a campaign. This API is idempotent.

Specified by:

updateCampaignDialerConfig in interface AmazonConnectCampaign

Parameters:

updateCampaignDialerConfigRequest - UpdateCampaignDialerConfigRequest

Returns:

Result of the UpdateCampaignDialerConfig operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateCampaignName

public UpdateCampaignNameResult updateCampaignName(UpdateCampaignNameRequest request)

Updates the name of a campaign. This API is idempotent.

Specified by:

updateCampaignName in interface AmazonConnectCampaign

Parameters:

updateCampaignNameRequest - UpdateCampaignNameRequest

Returns:

Result of the UpdateCampaignName operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateCampaignOutboundCallConfig

public UpdateCampaignOutboundCallConfigResult updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest request)

Updates the outbound call config of a campaign. This API is idempotent.

Specified by:

updateCampaignOutboundCallConfig in interface AmazonConnectCampaign

Parameters:

updateCampaignOutboundCallConfigRequest - UpdateCampaignOutboundCallConfigRequest

Returns:

Result of the UpdateCampaignOutboundCallConfig operation returned by the service.

Throws:

InternalServerException - Request processing failed because of an error or failure with the service.

ResourceNotFoundException - The specified resource was not found.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonConnectCampaign

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonConnectCampaign

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonConnectCampaign

Overrides:

shutdown in class AmazonWebServiceClient