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