com.amazonaws.services.connectcampaign.AmazonConnectCampaign Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-connectcampaign Show documentation
Show all versions of aws-java-sdk-connectcampaign Show documentation
The AWS Java SDK for AmazonConnectCampaign module holds the client classes that are used for communicating with AmazonConnectCampaign Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.connectcampaign;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.connectcampaign.model.*;
/**
* Interface for accessing AmazonConnectCampaignService.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.connectcampaign.AbstractAmazonConnectCampaign} instead.
*
*
*
* Provide APIs to create and manage Amazon Connect Campaigns.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectCampaign {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "connect-campaigns";
/**
*
* Creates a campaign for the specified Amazon Connect account. This API is idempotent.
*
*
* @param createCampaignRequest
* The request for Create Campaign API.
* @return Result of the CreateCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ServiceQuotaExceededException
* Request would cause a service quota to be exceeded.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.CreateCampaign
* @see AWS API Documentation
*/
CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest);
/**
*
* Deletes a campaign from the specified Amazon Connect account.
*
*
* @param deleteCampaignRequest
* DeleteCampaignRequest
* @return Result of the DeleteCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.DeleteCampaign
* @see AWS API Documentation
*/
DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest);
/**
*
* Deletes a connect instance config from the specified AWS account.
*
*
* @param deleteConnectInstanceConfigRequest
* DeleteCampaignRequest
* @return Result of the DeleteConnectInstanceConfig operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InvalidStateException
* The request could not be processed because of conflict in the current state.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.DeleteConnectInstanceConfig
* @see AWS API Documentation
*/
DeleteConnectInstanceConfigResult deleteConnectInstanceConfig(DeleteConnectInstanceConfigRequest deleteConnectInstanceConfigRequest);
/**
*
* Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
*
*
* @param deleteInstanceOnboardingJobRequest
* The request for DeleteInstanceOnboardingJob API.
* @return Result of the DeleteInstanceOnboardingJob operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InvalidStateException
* The request could not be processed because of conflict in the current state.
* @sample AmazonConnectCampaign.DeleteInstanceOnboardingJob
* @see AWS API Documentation
*/
DeleteInstanceOnboardingJobResult deleteInstanceOnboardingJob(DeleteInstanceOnboardingJobRequest deleteInstanceOnboardingJobRequest);
/**
*
* Describes the specific campaign.
*
*
* @param describeCampaignRequest
* DescribeCampaignRequests
* @return Result of the DescribeCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.DescribeCampaign
* @see AWS API Documentation
*/
DescribeCampaignResult describeCampaign(DescribeCampaignRequest describeCampaignRequest);
/**
*
* Get state of a campaign for the specified Amazon Connect account.
*
*
* @param getCampaignStateRequest
* GetCampaignStateRequest
* @return Result of the GetCampaignState operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.GetCampaignState
* @see AWS API Documentation
*/
GetCampaignStateResult getCampaignState(GetCampaignStateRequest getCampaignStateRequest);
/**
*
* Get state of campaigns for the specified Amazon Connect account.
*
*
* @param getCampaignStateBatchRequest
* GetCampaignStateBatchRequest
* @return Result of the GetCampaignStateBatch operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.GetCampaignStateBatch
* @see AWS API Documentation
*/
GetCampaignStateBatchResult getCampaignStateBatch(GetCampaignStateBatchRequest getCampaignStateBatchRequest);
/**
*
* Get the specific Connect instance config.
*
*
* @param getConnectInstanceConfigRequest
* GetConnectInstanceConfigRequest
* @return Result of the GetConnectInstanceConfig operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.GetConnectInstanceConfig
* @see AWS API Documentation
*/
GetConnectInstanceConfigResult getConnectInstanceConfig(GetConnectInstanceConfigRequest getConnectInstanceConfigRequest);
/**
*
* Get the specific instance onboarding job status.
*
*
* @param getInstanceOnboardingJobStatusRequest
* GetInstanceOnboardingJobStatusRequest
* @return Result of the GetInstanceOnboardingJobStatus operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.GetInstanceOnboardingJobStatus
* @see AWS API Documentation
*/
GetInstanceOnboardingJobStatusResult getInstanceOnboardingJobStatus(GetInstanceOnboardingJobStatusRequest getInstanceOnboardingJobStatusRequest);
/**
*
* Provides summary information about the campaigns under the specified Amazon Connect account.
*
*
* @param listCampaignsRequest
* ListCampaignsRequest
* @return Result of the ListCampaigns operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.ListCampaigns
* @see AWS
* API Documentation
*/
ListCampaignsResult listCampaigns(ListCampaignsRequest listCampaignsRequest);
/**
*
* List tags for a resource.
*
*
* @param listTagsForResourceRequest
* ListTagsForResource
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Pauses a campaign for the specified Amazon Connect account.
*
*
* @param pauseCampaignRequest
* PauseCampaignRequest
* @return Result of the PauseCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InvalidCampaignStateException
* The request could not be processed because of conflict in the current state of the campaign.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.PauseCampaign
* @see AWS
* API Documentation
*/
PauseCampaignResult pauseCampaign(PauseCampaignRequest pauseCampaignRequest);
/**
*
* Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
*
*
* @param putDialRequestBatchRequest
* PutDialRequestBatchRequest
* @return Result of the PutDialRequestBatch operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InvalidCampaignStateException
* The request could not be processed because of conflict in the current state of the campaign.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.PutDialRequestBatch
* @see AWS API Documentation
*/
PutDialRequestBatchResult putDialRequestBatch(PutDialRequestBatchRequest putDialRequestBatchRequest);
/**
*
* Stops a campaign for the specified Amazon Connect account.
*
*
* @param resumeCampaignRequest
* ResumeCampaignRequest
* @return Result of the ResumeCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InvalidCampaignStateException
* The request could not be processed because of conflict in the current state of the campaign.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.ResumeCampaign
* @see AWS API Documentation
*/
ResumeCampaignResult resumeCampaign(ResumeCampaignRequest resumeCampaignRequest);
/**
*
* Starts a campaign for the specified Amazon Connect account.
*
*
* @param startCampaignRequest
* StartCampaignRequest
* @return Result of the StartCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InvalidCampaignStateException
* The request could not be processed because of conflict in the current state of the campaign.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.StartCampaign
* @see AWS
* API Documentation
*/
StartCampaignResult startCampaign(StartCampaignRequest startCampaignRequest);
/**
*
* Onboard the specific Amazon Connect instance to Connect Campaigns.
*
*
* @param startInstanceOnboardingJobRequest
* The request for StartInstanceOnboardingJob API.
* @return Result of the StartInstanceOnboardingJob operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.StartInstanceOnboardingJob
* @see AWS API Documentation
*/
StartInstanceOnboardingJobResult startInstanceOnboardingJob(StartInstanceOnboardingJobRequest startInstanceOnboardingJobRequest);
/**
*
* Stops a campaign for the specified Amazon Connect account.
*
*
* @param stopCampaignRequest
* StopCampaignRequest
* @return Result of the StopCampaign operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InvalidCampaignStateException
* The request could not be processed because of conflict in the current state of the campaign.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.StopCampaign
* @see AWS
* API Documentation
*/
StopCampaignResult stopCampaign(StopCampaignRequest stopCampaignRequest);
/**
*
* Tag a resource.
*
*
* @param tagResourceRequest
* TagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Untag a resource.
*
*
* @param untagResourceRequest
* UntagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the dialer config of a campaign. This API is idempotent.
*
*
* @param updateCampaignDialerConfigRequest
* UpdateCampaignDialerConfigRequest
* @return Result of the UpdateCampaignDialerConfig operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.UpdateCampaignDialerConfig
* @see AWS API Documentation
*/
UpdateCampaignDialerConfigResult updateCampaignDialerConfig(UpdateCampaignDialerConfigRequest updateCampaignDialerConfigRequest);
/**
*
* Updates the name of a campaign. This API is idempotent.
*
*
* @param updateCampaignNameRequest
* UpdateCampaignNameRequest
* @return Result of the UpdateCampaignName operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @sample AmazonConnectCampaign.UpdateCampaignName
* @see AWS API Documentation
*/
UpdateCampaignNameResult updateCampaignName(UpdateCampaignNameRequest updateCampaignNameRequest);
/**
*
* Updates the outbound call config of a campaign. This API is idempotent.
*
*
* @param updateCampaignOutboundCallConfigRequest
* UpdateCampaignOutboundCallConfigRequest
* @return Result of the UpdateCampaignOutboundCallConfig operation returned by the service.
* @throws InternalServerException
* Request processing failed because of an error or failure with the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonConnectCampaign.UpdateCampaignOutboundCallConfig
* @see AWS API Documentation
*/
UpdateCampaignOutboundCallConfigResult updateCampaignOutboundCallConfig(UpdateCampaignOutboundCallConfigRequest updateCampaignOutboundCallConfigRequest);
/**
* 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.
*/
void shutdown();
/**
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}