ConnectCampaigns class
Provide APIs to create and manage Amazon Connect Campaigns.
Constructors
- ConnectCampaigns({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createCampaign(
{required String connectInstanceId, required DialerConfig dialerConfig, required String name, required OutboundCallConfig outboundCallConfig, Map< String, String> ? tags}) → Future<CreateCampaignResponse> - Creates a campaign for the specified Amazon Connect account. This API is idempotent.
-
deleteCampaign(
{required String id}) → Future< void> - Deletes a campaign from the specified Amazon Connect account.
-
deleteConnectInstanceConfig(
{required String connectInstanceId}) → Future< void> - Deletes a connect instance config from the specified AWS account.
-
deleteInstanceOnboardingJob(
{required String connectInstanceId}) → Future< void> - Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
-
describeCampaign(
{required String id}) → Future< DescribeCampaignResponse> - Describes the specific campaign.
-
getCampaignState(
{required String id}) → Future< GetCampaignStateResponse> - Get state of a campaign for the specified Amazon Connect account.
-
getCampaignStateBatch(
{required List< String> campaignIds}) → Future<GetCampaignStateBatchResponse> - Get state of campaigns for the specified Amazon Connect account.
-
getConnectInstanceConfig(
{required String connectInstanceId}) → Future< GetConnectInstanceConfigResponse> - Get the specific Connect instance config.
-
getInstanceOnboardingJobStatus(
{required String connectInstanceId}) → Future< GetInstanceOnboardingJobStatusResponse> - Get the specific instance onboarding job status.
-
listCampaigns(
{CampaignFilters? filters, int? maxResults, String? nextToken}) → Future< ListCampaignsResponse> - Provides summary information about the campaigns under the specified Amazon Connect account.
-
listTagsForResource(
{required String arn}) → Future< ListTagsForResourceResponse> - List tags for a resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseCampaign(
{required String id}) → Future< void> - Pauses a campaign for the specified Amazon Connect account.
-
putDialRequestBatch(
{required List< DialRequest> dialRequests, required String id}) → Future<PutDialRequestBatchResponse> - Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
-
resumeCampaign(
{required String id}) → Future< void> - Stops a campaign for the specified Amazon Connect account.
-
startCampaign(
{required String id}) → Future< void> - Starts a campaign for the specified Amazon Connect account.
-
startInstanceOnboardingJob(
{required String connectInstanceId, required EncryptionConfig encryptionConfig}) → Future< StartInstanceOnboardingJobResponse> - Onboard the specific Amazon Connect instance to Connect Campaigns.
-
stopCampaign(
{required String id}) → Future< void> - Stops a campaign for the specified Amazon Connect account.
-
tagResource(
{required String arn, required Map< String, String> tags}) → Future<void> - Tag a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String arn, required List< String> tagKeys}) → Future<void> - Untag a resource.
-
updateCampaignDialerConfig(
{required DialerConfig dialerConfig, required String id}) → Future< void> - Updates the dialer config of a campaign. This API is idempotent.
-
updateCampaignName(
{required String id, required String name}) → Future< void> - Updates the name of a campaign. This API is idempotent.
-
updateCampaignOutboundCallConfig(
{required String id, AnswerMachineDetectionConfig? answerMachineDetectionConfig, String? connectContactFlowId, String? connectSourcePhoneNumber}) → Future< void> - Updates the outbound call config of a campaign. This API is idempotent.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited