Skip to main content

campaigns

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

Overview

Namecampaigns
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Idaws.connectcampaigns.campaigns

Fields

NameDatatypeDescription
connect_instance_arnstringAmazon Connect Instance Arn
dialer_configobjectThe possible types of dialer config parameters
arnstringAmazon Connect Campaign Arn
namestringAmazon Connect Campaign Name
outbound_call_configobjectThe configuration used for outbound calls.
tagsarrayOne or more tags.
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTConnectInstanceArn, DialerConfig, Name, OutboundCallConfig, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all campaigns in a region.

SELECT
region,
connect_instance_arn,
dialer_config,
arn,
name,
outbound_call_config,
tags
FROM aws.connectcampaigns.campaigns
WHERE region = 'us-east-1';

Gets all properties from an individual campaign.

SELECT
region,
connect_instance_arn,
dialer_config,
arn,
name,
outbound_call_config,
tags
FROM aws.connectcampaigns.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.

/*+ create */
INSERT INTO aws.connectcampaigns.campaigns (
ConnectInstanceArn,
DialerConfig,
Name,
OutboundCallConfig,
region
)
SELECT
'{{ ConnectInstanceArn }}',
'{{ DialerConfig }}',
'{{ Name }}',
'{{ OutboundCallConfig }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.connectcampaigns.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:DescribeInstance,
connect:DescribeQueue

Read

connect-campaigns:DescribeCampaign

Delete

connect-campaigns:DeleteCampaign

List

connect-campaigns:ListCampaigns

Update

connect-campaigns:UpdateCampaignDialerConfig,
connect-campaigns:UpdateCampaignName,
connect-campaigns:UpdateCampaignOutboundCallConfig,
connect-campaigns:TagResource,
connect-campaigns:UntagResource,
connect-campaigns:DescribeCampaign