@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectCampaignClient extends AmazonWebServiceClient implements AmazonConnectCampaign
Provide APIs to create and manage Amazon Connect Campaigns.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX | 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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset public static AmazonConnectCampaignClientBuilder builder()
public CreateCampaignResult createCampaign(CreateCampaignRequest request)
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
createCampaign in interface AmazonConnectCampaign createCampaignRequest - The request for Create Campaign API.InternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.AccessDeniedException - You do not have sufficient access to perform this action.ServiceQuotaExceededException - Request would cause a service quota to be exceeded.ThrottlingException - The request was denied due to request throttling.public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
Deletes a campaign from the specified Amazon Connect account.
deleteCampaign in interface AmazonConnectCampaign deleteCampaignRequest - DeleteCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.public DeleteConnectInstanceConfigResult deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest request)
Deletes a connect instance config from the specified AWS account.
deleteConnectInstanceConfig in interface AmazonConnectCampaign deleteConnectInstanceConfigRequest - DeleteCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.InvalidStateException - The request could not be processed because of conflict in the current state.ThrottlingException - The request was denied due to request throttling.public DeleteInstanceOnboardingJobResult deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest request)
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
deleteInstanceOnboardingJob in interface AmazonConnectCampaign deleteInstanceOnboardingJobRequest - The request for DeleteInstanceOnboardingJob API.InternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.InvalidStateException - The request could not be processed because of conflict in the current state.public DescribeCampaignResult describeCampaign(DescribeCampaignRequest request)
Describes the specific campaign.
describeCampaign in interface AmazonConnectCampaign describeCampaignRequest - DescribeCampaignRequestsInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.public GetCampaignStateResult getCampaignState(GetCampaignStateRequest request)
Get state of a campaign for the specified Amazon Connect account.
getCampaignState in interface AmazonConnectCampaign getCampaignStateRequest - GetCampaignStateRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public GetCampaignStateBatchResult getCampaignStateBatch(GetCampaignStateBatchRequest request)
Get state of campaigns for the specified Amazon Connect account.
getCampaignStateBatch in interface AmazonConnectCampaign getCampaignStateBatchRequest - GetCampaignStateBatchRequestInternalServerException - Request processing failed because of an error or failure with the service.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public GetConnectInstanceConfigResult getConnectInstanceConfig(GetConnectInstanceConfigRequest request)
Get the specific Connect instance config.
getConnectInstanceConfig in interface AmazonConnectCampaign getConnectInstanceConfigRequest - GetConnectInstanceConfigRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.public GetInstanceOnboardingJobStatusResult getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest request)
Get the specific instance onboarding job status.
getInstanceOnboardingJobStatus in interface AmazonConnectCampaign getInstanceOnboardingJobStatusRequest - GetInstanceOnboardingJobStatusRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.public ListCampaignsResult listCampaigns(ListCampaignsRequest request)
Provides summary information about the campaigns under the specified Amazon Connect account.
listCampaigns in interface AmazonConnectCampaign listCampaignsRequest - ListCampaignsRequestInternalServerException - Request processing failed because of an error or failure with the service.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List tags for a resource.
listTagsForResource in interface AmazonConnectCampaign listTagsForResourceRequest - ListTagsForResourceInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public PauseCampaignResult pauseCampaign(PauseCampaignRequest request)
Pauses a campaign for the specified Amazon Connect account.
pauseCampaign in interface AmazonConnectCampaign pauseCampaignRequest - PauseCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public PutDialRequestBatchResult putDialRequestBatch(PutDialRequestBatchRequest request)
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
putDialRequestBatch in interface AmazonConnectCampaign putDialRequestBatchRequest - PutDialRequestBatchRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public ResumeCampaignResult resumeCampaign(ResumeCampaignRequest request)
Stops a campaign for the specified Amazon Connect account.
resumeCampaign in interface AmazonConnectCampaign resumeCampaignRequest - ResumeCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public StartCampaignResult startCampaign(StartCampaignRequest request)
Starts a campaign for the specified Amazon Connect account.
startCampaign in interface AmazonConnectCampaign startCampaignRequest - StartCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public StartInstanceOnboardingJobResult startInstanceOnboardingJob(StartInstanceOnboardingJobRequest request)
Onboard the specific Amazon Connect instance to Connect Campaigns.
startInstanceOnboardingJob in interface AmazonConnectCampaign startInstanceOnboardingJobRequest - The request for StartInstanceOnboardingJob API.InternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public StopCampaignResult stopCampaign(StopCampaignRequest request)
Stops a campaign for the specified Amazon Connect account.
stopCampaign in interface AmazonConnectCampaign stopCampaignRequest - StopCampaignRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.InvalidCampaignStateException - The request could not be processed because of conflict in the current state of the campaign.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public TagResourceResult tagResource(TagResourceRequest request)
Tag a resource.
tagResource in interface AmazonConnectCampaign tagResourceRequest - TagResourceRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public UntagResourceResult untagResource(UntagResourceRequest request)
Untag a resource.
untagResource in interface AmazonConnectCampaign untagResourceRequest - UntagResourceRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public UpdateCampaignDialerConfigResult updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest request)
Updates the dialer config of a campaign. This API is idempotent.
updateCampaignDialerConfig in interface AmazonConnectCampaign updateCampaignDialerConfigRequest - UpdateCampaignDialerConfigRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.AccessDeniedException - You do not have sufficient access to perform this action.public UpdateCampaignNameResult updateCampaignName(UpdateCampaignNameRequest request)
Updates the name of a campaign. This API is idempotent.
updateCampaignName in interface AmazonConnectCampaign updateCampaignNameRequest - UpdateCampaignNameRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.AccessDeniedException - You do not have sufficient access to perform this action.public UpdateCampaignOutboundCallConfigResult updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest request)
Updates the outbound call config of a campaign. This API is idempotent.
updateCampaignOutboundCallConfig in interface AmazonConnectCampaign updateCampaignOutboundCallConfigRequest - UpdateCampaignOutboundCallConfigRequestInternalServerException - Request processing failed because of an error or failure with the service.ResourceNotFoundException - The specified resource was not found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - The request could not be processed because of conflict in the current state of the resource.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonConnectCampaign request - The originally executed requestpublic void shutdown()
AmazonWebServiceClient shutdown in interface AmazonConnectCampaign shutdown in class AmazonWebServiceClient