campaigns

Creates, updates, deletes or gets a campaign resource or lists campaigns in a region

Overview

Name	campaigns
Type	Resource
Description	Definition of AWS::ConnectCampaignsV2::Campaign Resource Type
Id	aws.connectcampaignsv2.campaigns

Fields

Name	Datatype	Description
arn	string	Amazon Connect Campaign Arn
name	string	Campaign name
connect_instance_id	string	Amazon Connect Instance Id
channel_subtype_config	object	The possible types of channel subtype config parameters
source	object	The possible source of the campaign
connect_campaign_flow_arn	string	Arn
schedule	object	Campaign schedule
communication_time_config	object	Campaign communication time config
communication_limits_override	object	Communication limits config
tags	array	One or more tags.
region	string	AWS region.

For more information, see AWS::ConnectCampaignsV2::Campaign.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, ConnectInstanceId, ChannelSubtypeConfig, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all campaigns in a region.

SELECT
region,
arn,
name,
connect_instance_id,
channel_subtype_config,
source,
connect_campaign_flow_arn,
schedule,
communication_time_config,
communication_limits_override,
tags
FROM aws.connectcampaignsv2.campaigns
WHERE region = 'us-east-1';

Gets all properties from an individual campaign.

SELECT
region,
arn,
name,
connect_instance_id,
channel_subtype_config,
source,
connect_campaign_flow_arn,
schedule,
communication_time_config,
communication_limits_override,
tags
FROM aws.connectcampaignsv2.campaigns
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new campaign resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.connectcampaignsv2.campaigns (
 Name,
 ConnectInstanceId,
 ChannelSubtypeConfig,
 region
)
SELECT 
'{{ Name }}',
 '{{ ConnectInstanceId }}',
 '{{ ChannelSubtypeConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connectcampaignsv2.campaigns (
 Name,
 ConnectInstanceId,
 ChannelSubtypeConfig,
 Source,
 ConnectCampaignFlowArn,
 Schedule,
 CommunicationTimeConfig,
 CommunicationLimitsOverride,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ ConnectInstanceId }}',
 '{{ ChannelSubtypeConfig }}',
 '{{ Source }}',
 '{{ ConnectCampaignFlowArn }}',
 '{{ Schedule }}',
 '{{ CommunicationTimeConfig }}',
 '{{ CommunicationLimitsOverride }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: campaign
    props:
      - name: Name
        value: '{{ Name }}'
      - name: ConnectInstanceId
        value: '{{ ConnectInstanceId }}'
      - name: ChannelSubtypeConfig
        value:
          Telephony:
            Capacity: null
            ConnectQueueId: '{{ ConnectQueueId }}'
            OutboundMode:
              ProgressiveConfig:
                BandwidthAllocation: null
              PredictiveConfig:
                BandwidthAllocation: null
              AgentlessConfig: {}
            DefaultOutboundConfig:
              ConnectContactFlowId: '{{ ConnectContactFlowId }}'
              ConnectSourcePhoneNumber: '{{ ConnectSourcePhoneNumber }}'
              AnswerMachineDetectionConfig:
                EnableAnswerMachineDetection: '{{ EnableAnswerMachineDetection }}'
                AwaitAnswerMachinePrompt: '{{ AwaitAnswerMachinePrompt }}'
          Sms:
            Capacity: null
            OutboundMode:
              AgentlessConfig: null
            DefaultOutboundConfig:
              ConnectSourcePhoneNumberArn: '{{ ConnectSourcePhoneNumberArn }}'
              WisdomTemplateArn: null
          Email:
            Capacity: null
            OutboundMode:
              AgentlessConfig: null
            DefaultOutboundConfig:
              ConnectSourceEmailAddress: '{{ ConnectSourceEmailAddress }}'
              SourceEmailAddressDisplayName: '{{ SourceEmailAddressDisplayName }}'
              WisdomTemplateArn: null
      - name: Source
        value:
          CustomerProfilesSegmentArn: null
          EventTrigger:
            CustomerProfilesDomainArn: null
      - name: ConnectCampaignFlowArn
        value: null
      - name: Schedule
        value:
          StartTime: '{{ StartTime }}'
          EndTime: null
          RefreshFrequency: '{{ RefreshFrequency }}'
      - name: CommunicationTimeConfig
        value:
          LocalTimeZoneConfig:
            DefaultTimeZone: '{{ DefaultTimeZone }}'
            LocalTimeZoneDetection:
              - '{{ LocalTimeZoneDetection[0] }}'
          Telephony:
            OpenHours:
              DailyHours:
                - Key: '{{ Key }}'
                  Value:
                    - StartTime: '{{ StartTime }}'
                      EndTime: null
            RestrictedPeriods:
              RestrictedPeriodList:
                - Name: '{{ Name }}'
                  StartDate: '{{ StartDate }}'
                  EndDate: null
          Sms: null
          Email: null
      - name: CommunicationLimitsOverride
        value:
          AllChannelsSubtypes:
            CommunicationLimitList:
              - MaxCountPerRecipient: '{{ MaxCountPerRecipient }}'
                Frequency: '{{ Frequency }}'
                Unit: '{{ Unit }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connectcampaignsv2.campaigns
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the campaigns resource, the following permissions are required:

Create

connect-campaigns:CreateCampaign,
connect-campaigns:DescribeCampaign,
connect-campaigns:TagResource,
connect:DescribeContactFlow,
connect:DescribeEmailAddress,
connect:DescribeInstance,
connect:DescribePhoneNumber,
connect:DescribeQueue,
profile:GetSegmentDefinition,
wisdom:GetMessageTemplate

Read

connect-campaigns:DescribeCampaign

Delete

connect-campaigns:DeleteCampaign,
connect-campaigns:DeleteCampaignChannelSubtypeConfig,
connect-campaigns:DeleteCampaignCommunicationLimits,
connect-campaigns:DeleteCampaignCommunicationTime

List

connect-campaigns:ListCampaigns

Update

connect-campaigns:DeleteCampaignChannelSubtypeConfig,
connect-campaigns:DeleteCampaignCommunicationLimits,
connect-campaigns:DeleteCampaignCommunicationTime,
connect-campaigns:UpdateCampaignChannelSubtypeConfig,
connect-campaigns:UpdateCampaignCommunicationLimits,
connect-campaigns:UpdateCampaignCommunicationTime,
connect-campaigns:UpdateCampaignName,
connect-campaigns:UpdateCampaignFlowAssociation,
connect-campaigns:UpdateCampaignSchedule,
connect-campaigns:UpdateCampaignSource,
connect-campaigns:TagResource,
connect-campaigns:UntagResource,
connect-campaigns:DescribeCampaign,
connect:DescribeContactFlow,
connect:DescribeEmailAddress,
connect:DescribePhoneNumber,
connect:DescribeQueue,
profile:GetSegmentDefinition,
wisdom:GetMessageTemplate