campaigns

Creates, updates, deletes, gets or lists a campaigns resource.

Overview

Name	campaigns
Type	Resource
Id	aws.connectcampaignsv2.campaigns

Fields

The following fields are returned by SELECT queries:

describe_campaign

Name	Datatype	Description
id	string	Identifier representing a Campaign (pattern: <code>[-:/a-zA-Z0-9]+</code>)
name	string	The name of an Amazon Connect Campaign name.
arn	string	The resource name of an Amazon Connect campaign.
channel_subtype_config	object	Campaign Channel Subtype config
communication_limits_override	object	Communication limits config
communication_time_config	object	Campaign communication time config
connect_campaign_flow_arn	string	Amazon Resource Names(ARN) (pattern: <code>arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?::[^:]+)?</code>)
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[-_.a-zA-Z0-9]+</code>)
entry_limits_config	object	Campaign entry limits config
schedule	object	Campaign schedule
source	object	Source of the campaign
tags	object
type_	string	The type of campaign externally exposed in APIs. (MANAGED, JOURNEY)

list_campaigns

Name	Datatype	Description
id	string	Identifier representing a Campaign (pattern: <code>[-:/a-zA-Z0-9]+</code>)
name	string	The name of an Amazon Connect Campaign name.
arn	string	The resource name of an Amazon Connect campaign.
channel_subtypes	array	Channel subtype list
connect_campaign_flow_arn	string	Amazon Resource Names(ARN) (pattern: <code>arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?::[^:]+)?</code>)
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[-_.a-zA-Z0-9]+</code>)
entry_limits_config	object	Campaign entry limits config
schedule	object	Campaign schedule
type_	string	The type of campaign externally exposed in APIs. (MANAGED, JOURNEY)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_campaign	select	id, region		Describes the specific campaign.
list_campaigns	select	region		Provides summary information about the campaigns under the specified Amazon Connect account.
create_campaign	insert	region, name, connectInstanceId		Creates a campaign for the specified Amazon Connect account. This API is idempotent.
update_campaign_channel_subtype_config	update	id, region, channelSubtypeConfig		Updates the channel subtype config of a campaign. This API is idempotent.
update_campaign_communication_limits	update	id, region, communicationLimitsOverride		Updates the communication limits config for a campaign. This API is idempotent.
update_campaign_communication_time	update	id, region, communicationTimeConfig		Updates the communication time config for a campaign. This API is idempotent.
update_campaign_entry_limits	update	id, region, entryLimitsConfig		Updates the entry limits config for a campaign. This API is idempotent.
update_campaign_flow_association	update	id, region, connectCampaignFlowArn		Updates the campaign flow associated with a campaign. This API is idempotent.
update_campaign_name	update	id, region, name		Updates the name of a campaign. This API is idempotent.
update_campaign_schedule	update	id, region, schedule		Updates the schedule for a campaign. This API is idempotent.
update_campaign_source	update	id, region, source		Updates the campaign source with a campaign. This API is idempotent.
delete_campaign_channel_subtype_config	delete	id, channelSubtype, region		Deletes the channel subtype config of a campaign. This API is idempotent.
delete_campaign_communication_limits	delete	id, config, region		Deletes the communication limits config for a campaign. This API is idempotent.
delete_campaign	delete	id, region		Deletes a campaign from the specified Amazon Connect account.
delete_campaign_communication_time	exec	id, config, region		Deletes the communication time config for a campaign. This API is idempotent.
delete_campaign_entry_limits	exec	id, region		Deletes the entry limits config for a campaign. This API is idempotent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channelSubtype	string
config	string
id	string
region	string	AWS region (default: us-east-1)

SELECT examples

describe_campaign

Describes the specific campaign.

SELECT
id,
name,
arn,
channel_subtype_config,
communication_limits_override,
communication_time_config,
connect_campaign_flow_arn,
connect_instance_id,
entry_limits_config,
schedule,
source,
tags,
type_
FROM aws.connectcampaignsv2.campaigns
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_campaigns

Provides summary information about the campaigns under the specified Amazon Connect account.

SELECT
id,
name,
arn,
channel_subtypes,
connect_campaign_flow_arn,
connect_instance_id,
entry_limits_config,
schedule,
type_
FROM aws.connectcampaignsv2.campaigns
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_campaign

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

INSERT INTO aws.connectcampaignsv2.campaigns (
name,
connectInstanceId,
channelSubtypeConfig,
type,
source,
connectCampaignFlowArn,
schedule,
entryLimitsConfig,
communicationTimeConfig,
communicationLimitsOverride,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ connectInstanceId }}' /* required */,
'{{ channelSubtypeConfig }}',
'{{ type }}',
'{{ source }}',
'{{ connectCampaignFlowArn }}',
'{{ schedule }}',
'{{ entryLimitsConfig }}',
'{{ communicationTimeConfig }}',
'{{ communicationLimitsOverride }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: campaigns
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the campaigns resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of an Amazon Connect Campaign name.
  - name: connectInstanceId
    value: "{{ connectInstanceId }}"
    description: |
      Amazon Connect Instance Id
  - name: channelSubtypeConfig
    description: |
      Campaign Channel Subtype config
    value:
      telephony:
        capacity: {{ capacity }}
        connectQueueId: "{{ connectQueueId }}"
        outboundMode:
          progressive:
            bandwidthAllocation: {{ bandwidthAllocation }}
          predictive:
            bandwidthAllocation: {{ bandwidthAllocation }}
            pacingStrategies:
              - abandonmentRate:
                  targetRate: {{ targetRate }}
                  connectionStartPoint: "{{ connectionStartPoint }}"
                  connectionThresholdSeconds: {{ connectionThresholdSeconds }}
                  evaluationWindow: "{{ evaluationWindow }}"
          agentless: "{{ agentless }}"
          preview:
            bandwidthAllocation: {{ bandwidthAllocation }}
            timeoutConfig:
              durationInSeconds: {{ durationInSeconds }}
            agentActions:
              - "{{ agentActions }}"
        defaultOutboundConfig:
          connectContactFlowId: "{{ connectContactFlowId }}"
          connectSourcePhoneNumber: "{{ connectSourcePhoneNumber }}"
          answerMachineDetectionConfig:
            enableAnswerMachineDetection: {{ enableAnswerMachineDetection }}
            awaitAnswerMachinePrompt: {{ awaitAnswerMachinePrompt }}
          ringTimeout: {{ ringTimeout }}
      sms:
        capacity: {{ capacity }}
        outboundMode:
          agentless: "{{ agentless }}"
        defaultOutboundConfig:
          connectSourcePhoneNumberArn: "{{ connectSourcePhoneNumberArn }}"
          wisdomTemplateArn: "{{ wisdomTemplateArn }}"
      email:
        capacity: {{ capacity }}
        outboundMode:
          agentless: "{{ agentless }}"
        defaultOutboundConfig:
          connectSourceEmailAddress: "{{ connectSourceEmailAddress }}"
          sourceEmailAddressDisplayName: "{{ sourceEmailAddressDisplayName }}"
          wisdomTemplateArn: "{{ wisdomTemplateArn }}"
      whatsApp:
        capacity: {{ capacity }}
        outboundMode:
          agentless: "{{ agentless }}"
        defaultOutboundConfig:
          connectSourcePhoneNumberArn: "{{ connectSourcePhoneNumberArn }}"
          wisdomTemplateArn: "{{ wisdomTemplateArn }}"
  - name: type
    value: "{{ type }}"
    description: |
      The type of campaign externally exposed in APIs.
    valid_values: ['MANAGED', 'JOURNEY']
  - name: source
    description: |
      Source of the campaign
    value:
      customerProfilesSegmentArn: "{{ customerProfilesSegmentArn }}"
      eventTrigger:
        customerProfilesDomainArn: "{{ customerProfilesDomainArn }}"
  - name: connectCampaignFlowArn
    value: "{{ connectCampaignFlowArn }}"
    description: |
      Amazon Resource Names(ARN)
  - name: schedule
    description: |
      Campaign schedule
    value:
      startTime: "{{ startTime }}"
      endTime: "{{ endTime }}"
      refreshFrequency: "{{ refreshFrequency }}"
  - name: entryLimitsConfig
    description: |
      Campaign entry limits config
    value:
      maxEntryCount: {{ maxEntryCount }}
      minEntryInterval: "{{ minEntryInterval }}"
  - name: communicationTimeConfig
    description: |
      Campaign communication time config
    value:
      localTimeZoneConfig:
        defaultTimeZone: "{{ defaultTimeZone }}"
        localTimeZoneDetection:
          - "{{ localTimeZoneDetection }}"
        localTimeZoneDetectionScope: "{{ localTimeZoneDetectionScope }}"
      telephony:
        openHours:
          dailyHours: "{{ dailyHours }}"
        restrictedPeriods:
          restrictedPeriodList:
            - name: "{{ name }}"
              startDate: "{{ startDate }}"
              endDate: "{{ endDate }}"
      sms:
        openHours:
          dailyHours: "{{ dailyHours }}"
        restrictedPeriods:
          restrictedPeriodList:
            - name: "{{ name }}"
              startDate: "{{ startDate }}"
              endDate: "{{ endDate }}"
      email:
        openHours:
          dailyHours: "{{ dailyHours }}"
        restrictedPeriods:
          restrictedPeriodList:
            - name: "{{ name }}"
              startDate: "{{ startDate }}"
              endDate: "{{ endDate }}"
      whatsApp:
        openHours:
          dailyHours: "{{ dailyHours }}"
        restrictedPeriods:
          restrictedPeriodList:
            - name: "{{ name }}"
              startDate: "{{ startDate }}"
              endDate: "{{ endDate }}"
  - name: communicationLimitsOverride
    description: |
      Communication limits config
    value:
      allChannelSubtypes:
        communicationLimitsList:
          - maxCountPerRecipient: {{ maxCountPerRecipient }}
            frequency: {{ frequency }}
            unit: "{{ unit }}"
      instanceLimitsHandling: "{{ instanceLimitsHandling }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Tag map with key and value.

UPDATE examples

update_campaign_channel_subtype_config

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
channelSubtypeConfig = '{{ channelSubtypeConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND channelSubtypeConfig = '{{ channelSubtypeConfig }}' --required;

update_campaign_communication_limits

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
communicationLimitsOverride = '{{ communicationLimitsOverride }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND communicationLimitsOverride = '{{ communicationLimitsOverride }}' --required;

update_campaign_communication_time

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
communicationTimeConfig = '{{ communicationTimeConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND communicationTimeConfig = '{{ communicationTimeConfig }}' --required;

update_campaign_entry_limits

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
entryLimitsConfig = '{{ entryLimitsConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND entryLimitsConfig = '{{ entryLimitsConfig }}' --required;

update_campaign_flow_association

Updates the campaign flow associated with a campaign. This API is idempotent.

UPDATE aws.connectcampaignsv2.campaigns
SET 
connectCampaignFlowArn = '{{ connectCampaignFlowArn }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND connectCampaignFlowArn = '{{ connectCampaignFlowArn }}' --required;

update_campaign_name

Updates the name of a campaign. This API is idempotent.

UPDATE aws.connectcampaignsv2.campaigns
SET 
name = '{{ name }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required;

update_campaign_schedule

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
schedule = '{{ schedule }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND schedule = '{{ schedule }}' --required;

update_campaign_source

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

UPDATE aws.connectcampaignsv2.campaigns
SET 
source = '{{ source }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND source = '{{ source }}' --required;

DELETE examples

delete_campaign_channel_subtype_config

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

DELETE FROM aws.connectcampaignsv2.campaigns
WHERE id = '{{ id }}' --required
AND channelSubtype = '{{ channelSubtype }}' --required
AND region = '{{ region }}' --required
;

delete_campaign_communication_limits

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

DELETE FROM aws.connectcampaignsv2.campaigns
WHERE id = '{{ id }}' --required
AND config = '{{ config }}' --required
AND region = '{{ region }}' --required
;

delete_campaign

Deletes a campaign from the specified Amazon Connect account.

DELETE FROM aws.connectcampaignsv2.campaigns
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

delete_campaign_communication_time

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

EXEC aws.connectcampaignsv2.campaigns.delete_campaign_communication_time 
@id='{{ id }}' --required, 
@config='{{ config }}' --required, 
@region='{{ region }}' --required
;

delete_campaign_entry_limits

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

EXEC aws.connectcampaignsv2.campaigns.delete_campaign_entry_limits 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;