ConnectCampaignsV2 class

Provide APIs to create and manage Amazon Connect Campaigns.

Constructors

ConnectCampaignsV2({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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 String name, ChannelSubtypeConfig? channelSubtypeConfig, CommunicationLimitsConfig? communicationLimitsOverride, CommunicationTimeConfig? communicationTimeConfig, String? connectCampaignFlowArn, EntryLimitsConfig? entryLimitsConfig, Schedule? schedule, Source? source, Map<String, String>? tags, ExternalCampaignType? type}) → 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.

deleteCampaignChannelSubtypeConfig({required ChannelSubtype channelSubtype, required String id}) → Future<void>

Deletes the channel subtype config of a campaign. This API is idempotent.

deleteCampaignCommunicationLimits({required CommunicationLimitsConfigType config, required String id}) → Future<void>

Deletes the communication limits config for a campaign. This API is idempotent.

deleteCampaignCommunicationTime({required CommunicationTimeConfigType config, required String id}) → Future<void>

Deletes the communication time config for a campaign. This API is idempotent.

deleteCampaignEntryLimits({required String id}) → Future<void>

Deletes the entry limits config for a campaign. This API is idempotent.

deleteConnectInstanceConfig({required String connectInstanceId, CampaignDeletionPolicy? campaignDeletionPolicy}) → Future<void>

Deletes a connect instance config from the specified AWS account.

deleteConnectInstanceIntegration({required String connectInstanceId, required IntegrationIdentifier integrationIdentifier}) → Future<void>

Delete the integration for the specified Amazon Connect instance.

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.

getInstanceCommunicationLimits({required String connectInstanceId}) → Future<GetInstanceCommunicationLimitsResponse>

Get the instance communication limits.

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.

listConnectInstanceIntegrations({required String connectInstanceId, int? maxResults, String? nextToken}) → Future<ListConnectInstanceIntegrationsResponse>

Provides summary information about the integration under the specified Connect instance.

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.

putConnectInstanceIntegration({required String connectInstanceId, required IntegrationConfig integrationConfig}) → Future<void>

Put or update the integration for the specified Amazon Connect instance.

putInstanceCommunicationLimits({required InstanceCommunicationLimitsConfig communicationLimitsConfig, required String connectInstanceId}) → Future<void>

Put the instance communication limits. This API is idempotent.

putOutboundRequestBatch({required String id, required List<OutboundRequest> outboundRequests}) → Future<PutOutboundRequestBatchResponse>

Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.

putProfileOutboundRequestBatch({required String id, required List<ProfileOutboundRequest> profileOutboundRequests}) → Future<PutProfileOutboundRequestBatchResponse>

Takes in a list of profile outbound requests to be placed as part of an outbound campaign. 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.

updateCampaignChannelSubtypeConfig({required ChannelSubtypeConfig channelSubtypeConfig, required String id}) → Future<void>

Updates the channel subtype config of a campaign. This API is idempotent.

updateCampaignCommunicationLimits({required CommunicationLimitsConfig communicationLimitsOverride, required String id}) → Future<void>

Updates the communication limits config for a campaign. This API is idempotent.

updateCampaignCommunicationTime({required CommunicationTimeConfig communicationTimeConfig, required String id}) → Future<void>

Updates the communication time config for a campaign. This API is idempotent.

updateCampaignEntryLimits({required EntryLimitsConfig entryLimitsConfig, required String id}) → Future<void>

Updates the entry limits config for a campaign. This API is idempotent.

updateCampaignFlowAssociation({required String connectCampaignFlowArn, required String id}) → Future<void>

Updates the campaign flow associated with 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.

updateCampaignSchedule({required String id, required Schedule schedule}) → Future<void>

Updates the schedule for a campaign. This API is idempotent.

updateCampaignSource({required String id, required Source source}) → Future<void>

Updates the campaign source with a campaign. This API is idempotent.

Operators

operator ==(Object other) → bool

The equality operator.

inherited