/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the connectcampaigns-2021-01-30.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ConnectCampaignService.Model;
namespace Amazon.ConnectCampaignService
{
///
/// Interface for accessing ConnectCampaignService
///
/// Provide APIs to create and manage Amazon Connect Campaigns.
///
public partial interface IAmazonConnectCampaignService : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IConnectCampaignServicePaginatorFactory Paginators { get; }
#endif
#region CreateCampaign
///
/// Creates a campaign for the specified Amazon Connect account. This API is idempotent.
///
/// Container for the necessary parameters to execute the CreateCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// Request would cause a service quota to be exceeded.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CreateCampaign Operation
Task CreateCampaignAsync(CreateCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteCampaign
///
/// Deletes a campaign from the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the DeleteCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteCampaign Operation
Task DeleteCampaignAsync(DeleteCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteConnectInstanceConfig
///
/// Deletes a connect instance config from the specified AWS account.
///
/// Container for the necessary parameters to execute the DeleteConnectInstanceConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteConnectInstanceConfig service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteConnectInstanceConfig Operation
Task DeleteConnectInstanceConfigAsync(DeleteConnectInstanceConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteInstanceOnboardingJob
///
/// Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
///
/// Container for the necessary parameters to execute the DeleteInstanceOnboardingJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteInstanceOnboardingJob service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteInstanceOnboardingJob Operation
Task DeleteInstanceOnboardingJobAsync(DeleteInstanceOnboardingJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCampaign
///
/// Describes the specific campaign.
///
/// Container for the necessary parameters to execute the DescribeCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DescribeCampaign Operation
Task DescribeCampaignAsync(DescribeCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCampaignState
///
/// Get state of a campaign for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the GetCampaignState service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetCampaignState service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetCampaignState Operation
Task GetCampaignStateAsync(GetCampaignStateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCampaignStateBatch
///
/// Get state of campaigns for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the GetCampaignStateBatch service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetCampaignStateBatch service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetCampaignStateBatch Operation
Task GetCampaignStateBatchAsync(GetCampaignStateBatchRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetConnectInstanceConfig
///
/// Get the specific Connect instance config.
///
/// Container for the necessary parameters to execute the GetConnectInstanceConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetConnectInstanceConfig service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetConnectInstanceConfig Operation
Task GetConnectInstanceConfigAsync(GetConnectInstanceConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetInstanceOnboardingJobStatus
///
/// Get the specific instance onboarding job status.
///
/// Container for the necessary parameters to execute the GetInstanceOnboardingJobStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetInstanceOnboardingJobStatus service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetInstanceOnboardingJobStatus Operation
Task GetInstanceOnboardingJobStatusAsync(GetInstanceOnboardingJobStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListCampaigns
///
/// Provides summary information about the campaigns under the specified Amazon Connect
/// account.
///
/// Container for the necessary parameters to execute the ListCampaigns service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListCampaigns service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListCampaigns Operation
Task ListCampaignsAsync(ListCampaignsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// List tags for a resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PauseCampaign
///
/// Pauses a campaign for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the PauseCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PauseCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state of the
/// campaign.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for PauseCampaign Operation
Task PauseCampaignAsync(PauseCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutDialRequestBatch
///
/// Creates dials requests for the specified campaign Amazon Connect account. This API
/// is idempotent.
///
/// Container for the necessary parameters to execute the PutDialRequestBatch service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutDialRequestBatch service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state of the
/// campaign.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for PutDialRequestBatch Operation
Task PutDialRequestBatchAsync(PutDialRequestBatchRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ResumeCampaign
///
/// Stops a campaign for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the ResumeCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ResumeCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state of the
/// campaign.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ResumeCampaign Operation
Task ResumeCampaignAsync(ResumeCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartCampaign
///
/// Starts a campaign for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the StartCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state of the
/// campaign.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StartCampaign Operation
Task StartCampaignAsync(StartCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartInstanceOnboardingJob
///
/// Onboard the specific Amazon Connect instance to Connect Campaigns.
///
/// Container for the necessary parameters to execute the StartInstanceOnboardingJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartInstanceOnboardingJob service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StartInstanceOnboardingJob Operation
Task StartInstanceOnboardingJobAsync(StartInstanceOnboardingJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopCampaign
///
/// Stops a campaign for the specified Amazon Connect account.
///
/// Container for the necessary parameters to execute the StopCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopCampaign service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The request could not be processed because of conflict in the current state of the
/// campaign.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StopCampaign Operation
Task StopCampaignAsync(StopCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Tag a resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Untag a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCampaignDialerConfig
///
/// Updates the dialer config of a campaign. This API is idempotent.
///
/// Container for the necessary parameters to execute the UpdateCampaignDialerConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateCampaignDialerConfig service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateCampaignDialerConfig Operation
Task UpdateCampaignDialerConfigAsync(UpdateCampaignDialerConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCampaignName
///
/// Updates the name of a campaign. This API is idempotent.
///
/// Container for the necessary parameters to execute the UpdateCampaignName service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateCampaignName service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateCampaignName Operation
Task UpdateCampaignNameAsync(UpdateCampaignNameRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCampaignOutboundCallConfig
///
/// Updates the outbound call config of a campaign. This API is idempotent.
///
/// Container for the necessary parameters to execute the UpdateCampaignOutboundCallConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateCampaignOutboundCallConfig service method, as returned by ConnectCampaignService.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request could not be processed because of conflict in the current state of the
/// resource.
///
///
/// Request processing failed because of an error or failure with the service.
///
///
/// The specified resource was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateCampaignOutboundCallConfig Operation
Task UpdateCampaignOutboundCallConfigAsync(UpdateCampaignOutboundCallConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}