campaigns

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

Overview

Name	campaigns
Type	Resource
Id	aws.connectcampaigns.campaigns

Fields

The following fields are returned by SELECT queries:

describe_campaign

Name	Datatype	Description
id	string	Identifier representing a Campaign (pattern: <code>[\S]*</code>)
name	string	The name of an Amazon Connect Campaign name.
arn	string	The resource name of an Amazon Connect campaign.
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[a-zA-Z0-9_-.]*</code>)
dialer_config	object	The possible types of dialer config parameters
outbound_call_config	object	The configuration used for outbound calls.
tags	object

list_campaigns

Name	Datatype	Description
id	string	Identifier representing a Campaign (pattern: <code>[\S]*</code>)
name	string	The name of an Amazon Connect Campaign name.
arn	string	The resource name of an Amazon Connect campaign.
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[a-zA-Z0-9_-.]*</code>)

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, dialerConfig, outboundCallConfig		Creates a campaign for the specified Amazon Connect account. This API is idempotent.
update_campaign_dialer_config	update	id, region, dialerConfig		Updates the dialer config of 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_outbound_call_config	update	id, region		Updates the outbound call config of a campaign. This API is idempotent.
delete_campaign	delete	id, region		Deletes a campaign from the specified Amazon Connect account.

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
id	string
region	string	AWS region (default: us-east-1)

SELECT examples

describe_campaign

Describes the specific campaign.

SELECT
id,
name,
arn,
connect_instance_id,
dialer_config,
outbound_call_config,
tags
FROM aws.connectcampaigns.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,
connect_instance_id
FROM aws.connectcampaigns.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.connectcampaigns.campaigns (
name,
connectInstanceId,
dialerConfig,
outboundCallConfig,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ connectInstanceId }}' /* required */,
'{{ dialerConfig }}' /* required */,
'{{ outboundCallConfig }}' /* required */,
'{{ 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: dialerConfig
    description: |
      The possible types of dialer config parameters
    value:
      progressiveDialerConfig:
        bandwidthAllocation: {{ bandwidthAllocation }}
        dialingCapacity: {{ dialingCapacity }}
      predictiveDialerConfig:
        bandwidthAllocation: {{ bandwidthAllocation }}
        dialingCapacity: {{ dialingCapacity }}
      agentlessDialerConfig:
        dialingCapacity: {{ dialingCapacity }}
  - name: outboundCallConfig
    description: |
      The configuration used for outbound calls.
    value:
      connectContactFlowId: "{{ connectContactFlowId }}"
      connectSourcePhoneNumber: "{{ connectSourcePhoneNumber }}"
      connectQueueId: "{{ connectQueueId }}"
      answerMachineDetectionConfig:
        enableAnswerMachineDetection: {{ enableAnswerMachineDetection }}
        awaitAnswerMachinePrompt: {{ awaitAnswerMachinePrompt }}
  - name: tags
    value: "{{ tags }}"
    description: |
      Tag map with key and value.

UPDATE examples

update_campaign_dialer_config

Updates the dialer config of a campaign. This API is idempotent.

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

update_campaign_name

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

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

update_campaign_outbound_call_config

Updates the outbound call config of a campaign. This API is idempotent.

UPDATE aws.connectcampaigns.campaigns
SET 
connectContactFlowId = '{{ connectContactFlowId }}',
connectSourcePhoneNumber = '{{ connectSourcePhoneNumber }}',
answerMachineDetectionConfig = '{{ answerMachineDetectionConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_campaign

Deletes a campaign from the specified Amazon Connect account.

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