campaigns
Creates, updates, deletes or gets a campaign
resource or lists campaigns
in a region
Overview
Name | campaigns |
Type | Resource |
Description | Definition of AWS::ConnectCampaigns::Campaign Resource Type |
Id | aws.connectcampaigns.campaigns |
Fields
Name | Datatype | Description |
---|---|---|
connect_instance_arn | string | Amazon Connect Instance Arn |
dialer_config | object | The possible types of dialer config parameters |
arn | string | Amazon Connect Campaign Arn |
name | string | Amazon Connect Campaign Name |
outbound_call_config | object | The configuration used for outbound calls. |
tags | array | One or more tags. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | ConnectInstanceArn, DialerConfig, Name, OutboundCallConfig, 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,
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
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.connectcampaigns.campaigns (
ConnectInstanceArn,
DialerConfig,
Name,
OutboundCallConfig,
region
)
SELECT
'{{ ConnectInstanceArn }}',
'{{ DialerConfig }}',
'{{ Name }}',
'{{ OutboundCallConfig }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.connectcampaigns.campaigns (
ConnectInstanceArn,
DialerConfig,
Name,
OutboundCallConfig,
Tags,
region
)
SELECT
'{{ ConnectInstanceArn }}',
'{{ DialerConfig }}',
'{{ Name }}',
'{{ OutboundCallConfig }}',
'{{ Tags }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: campaign
props:
- name: ConnectInstanceArn
value: '{{ ConnectInstanceArn }}'
- name: DialerConfig
value:
ProgressiveDialerConfig:
BandwidthAllocation: null
DialingCapacity: null
PredictiveDialerConfig:
BandwidthAllocation: null
DialingCapacity: null
AgentlessDialerConfig:
DialingCapacity: null
- name: Name
value: '{{ Name }}'
- name: OutboundCallConfig
value:
ConnectContactFlowArn: '{{ ConnectContactFlowArn }}'
ConnectSourcePhoneNumber: '{{ ConnectSourcePhoneNumber }}'
ConnectQueueArn: '{{ ConnectQueueArn }}'
AnswerMachineDetectionConfig:
EnableAnswerMachineDetection: '{{ EnableAnswerMachineDetection }}'
AwaitAnswerMachinePrompt: '{{ AwaitAnswerMachinePrompt }}'
- name: Tags
value:
- Key: '{{ Key }}'
Value: '{{ Value }}'
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