Skip to content
AWS for Query.Farm

aws.connectcampaigns.describe_campaign

Example SQL Queries

SELECT * FROM
aws.connectcampaigns.describe_campaign
WHERE
"id" = 'VALUE';

Description

Describes the specific campaign.

Table Definition

Column NameColumn Data Type
id Required Input Column

Identifier representing a Campaign

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

campaign

An Amazon Connect campaign.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "connect_instance_id" VARCHAR,
    "dialer_config" STRUCT(
        "progressive_dialer_config" STRUCT(
            "bandwidth_allocation" DOUBLE,
            "dialing_capacity" DOUBLE
        ),
        "predictive_dialer_config" STRUCT(
            "bandwidth_allocation" DOUBLE,
            "dialing_capacity" DOUBLE
        ),
        "agentless_dialer_config" STRUCT(
            "dialing_capacity" DOUBLE
        )
    ),
    "outbound_call_config" STRUCT(
        "connect_contact_flow_id" VARCHAR,
        "connect_source_phone_number" VARCHAR,
        "connect_queue_id" VARCHAR,
        "answer_machine_detection_config" STRUCT(
            "enable_answer_machine_detection" BOOLEAN,
            "await_answer_machine_prompt" BOOLEAN
        )
    ),
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
campaign.arn

The resource name of an Amazon Connect campaign.

campaign.connect_instance_id

Amazon Connect Instance Id

campaign.dialer_config

The possible types of dialer config parameters

Show child fields
campaign.dialer_config.agentless_dialer_config

Agentless Dialer config

Show child fields
campaign.dialer_config.agentless_dialer_config.dialing_capacity

Allocates dialing capacity for this campaign between multiple active campaigns

campaign.dialer_config.predictive_dialer_config

Predictive Dialer config

Show child fields
campaign.dialer_config.predictive_dialer_config.bandwidth_allocation

The bandwidth allocation of a queue resource.

campaign.dialer_config.predictive_dialer_config.dialing_capacity

Allocates dialing capacity for this campaign between multiple active campaigns

campaign.dialer_config.progressive_dialer_config

Progressive Dialer config

Show child fields
campaign.dialer_config.progressive_dialer_config.bandwidth_allocation

The bandwidth allocation of a queue resource.

campaign.dialer_config.progressive_dialer_config.dialing_capacity

Allocates dialing capacity for this campaign between multiple active campaigns

campaign.id

Identifier representing a Campaign

campaign.name

The name of an Amazon Connect Campaign name.

campaign.outbound_call_config

The configuration used for outbound calls.

Show child fields
campaign.outbound_call_config.answer_machine_detection_config

Answering Machine Detection config

Show child fields
campaign.outbound_call_config.answer_machine_detection_config.await_answer_machine_prompt

Enable or disable await answer machine prompt

campaign.outbound_call_config.answer_machine_detection_config.enable_answer_machine_detection

Enable or disable answering machine detection

campaign.outbound_call_config.connect_contact_flow_id

The identifier of the contact flow for the outbound call.

campaign.outbound_call_config.connect_queue_id

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

campaign.outbound_call_config.connect_source_phone_number

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

campaign.tags

Tag map with key and value.