Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. connectcampaigns
  5. getCampaign

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connectcampaigns.getCampaign

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::ConnectCampaigns::Campaign Resource Type

    Using getCampaign

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCampaign(args: GetCampaignArgs, opts?: InvokeOptions): Promise<GetCampaignResult>
function getCampaignOutput(args: GetCampaignOutputArgs, opts?: InvokeOptions): Output<GetCampaignResult>
    def get_campaign(arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCampaignResult
def get_campaign_output(arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCampaignResult]
    func LookupCampaign(ctx *Context, args *LookupCampaignArgs, opts ...InvokeOption) (*LookupCampaignResult, error)
func LookupCampaignOutput(ctx *Context, args *LookupCampaignOutputArgs, opts ...InvokeOption) LookupCampaignResultOutput

    > Note: This function is named LookupCampaign in the Go SDK.

    public static class GetCampaign 
{
    public static Task<GetCampaignResult> InvokeAsync(GetCampaignArgs args, InvokeOptions? opts = null)
    public static Output<GetCampaignResult> Invoke(GetCampaignInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:connectcampaigns:getCampaign
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Amazon Connect Campaign Arn
    Arn string
    Amazon Connect Campaign Arn
    arn String
    Amazon Connect Campaign Arn
    arn string
    Amazon Connect Campaign Arn
    arn str
    Amazon Connect Campaign Arn
    arn String
    Amazon Connect Campaign Arn

    getCampaign Result

    The following output properties are available:

    Arn string
    Amazon Connect Campaign Arn
    DialerConfig Pulumi.AwsNative.ConnectCampaigns.Outputs.CampaignDialerConfig
    Contains information about the dialer configuration.
    Name string
    Amazon Connect Campaign Name
    OutboundCallConfig Pulumi.AwsNative.ConnectCampaigns.Outputs.CampaignOutboundCallConfig
    Contains information about the outbound call configuration.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags.
    Arn string
    Amazon Connect Campaign Arn
    DialerConfig CampaignDialerConfig
    Contains information about the dialer configuration.
    Name string
    Amazon Connect Campaign Name
    OutboundCallConfig CampaignOutboundCallConfig
    Contains information about the outbound call configuration.
    Tags Tag
    One or more tags.
    arn String
    Amazon Connect Campaign Arn
    dialerConfig CampaignDialerConfig
    Contains information about the dialer configuration.
    name String
    Amazon Connect Campaign Name
    outboundCallConfig CampaignOutboundCallConfig
    Contains information about the outbound call configuration.
    tags List<Tag>
    One or more tags.
    arn string
    Amazon Connect Campaign Arn
    dialerConfig CampaignDialerConfig
    Contains information about the dialer configuration.
    name string
    Amazon Connect Campaign Name
    outboundCallConfig CampaignOutboundCallConfig
    Contains information about the outbound call configuration.
    tags Tag[]
    One or more tags.
    arn str
    Amazon Connect Campaign Arn
    dialer_config CampaignDialerConfig
    Contains information about the dialer configuration.
    name str
    Amazon Connect Campaign Name
    outbound_call_config CampaignOutboundCallConfig
    Contains information about the outbound call configuration.
    tags Sequence[root_Tag]
    One or more tags.
    arn String
    Amazon Connect Campaign Arn
    dialerConfig Property Map
    Contains information about the dialer configuration.
    name String
    Amazon Connect Campaign Name
    outboundCallConfig Property Map
    Contains information about the outbound call configuration.
    tags List<Property Map>
    One or more tags.

    Supporting Types

    CampaignAgentlessDialerConfig

    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity number
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialing_capacity float
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    CampaignAnswerMachineDetectionConfig

    EnableAnswerMachineDetection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    AwaitAnswerMachinePrompt bool
    Enables detection of prompts (e.g., beep after after a voicemail greeting)
    EnableAnswerMachineDetection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    AwaitAnswerMachinePrompt bool
    Enables detection of prompts (e.g., beep after after a voicemail greeting)
    enableAnswerMachineDetection Boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    awaitAnswerMachinePrompt Boolean
    Enables detection of prompts (e.g., beep after after a voicemail greeting)
    enableAnswerMachineDetection boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    awaitAnswerMachinePrompt boolean
    Enables detection of prompts (e.g., beep after after a voicemail greeting)
    enable_answer_machine_detection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    await_answer_machine_prompt bool
    Enables detection of prompts (e.g., beep after after a voicemail greeting)
    enableAnswerMachineDetection Boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    awaitAnswerMachinePrompt Boolean
    Enables detection of prompts (e.g., beep after after a voicemail greeting)

    CampaignDialerConfig

    AgentlessDialerConfig CampaignAgentlessDialerConfig
    The configuration of the agentless dialer.
    PredictiveDialerConfig CampaignPredictiveDialerConfig
    The configuration of the predictive dialer.
    ProgressiveDialerConfig CampaignProgressiveDialerConfig
    The configuration of the progressive dialer.
    agentlessDialerConfig CampaignAgentlessDialerConfig
    The configuration of the agentless dialer.
    predictiveDialerConfig CampaignPredictiveDialerConfig
    The configuration of the predictive dialer.
    progressiveDialerConfig CampaignProgressiveDialerConfig
    The configuration of the progressive dialer.
    agentlessDialerConfig CampaignAgentlessDialerConfig
    The configuration of the agentless dialer.
    predictiveDialerConfig CampaignPredictiveDialerConfig
    The configuration of the predictive dialer.
    progressiveDialerConfig CampaignProgressiveDialerConfig
    The configuration of the progressive dialer.
    agentless_dialer_config CampaignAgentlessDialerConfig
    The configuration of the agentless dialer.
    predictive_dialer_config CampaignPredictiveDialerConfig
    The configuration of the predictive dialer.
    progressive_dialer_config CampaignProgressiveDialerConfig
    The configuration of the progressive dialer.
    agentlessDialerConfig Property Map
    The configuration of the agentless dialer.
    predictiveDialerConfig Property Map
    The configuration of the predictive dialer.
    progressiveDialerConfig Property Map
    The configuration of the progressive dialer.

    CampaignOutboundCallConfig

    ConnectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    AnswerMachineDetectionConfig Pulumi.AwsNative.ConnectCampaigns.Inputs.CampaignAnswerMachineDetectionConfig
    Whether answering machine detection has been enabled.
    ConnectQueueArn string
    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.
    ConnectSourcePhoneNumber string
    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.
    ConnectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    AnswerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    Whether answering machine detection has been enabled.
    ConnectQueueArn string
    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.
    ConnectSourcePhoneNumber string
    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.
    connectContactFlowArn String
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    Whether answering machine detection has been enabled.
    connectQueueArn String
    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.
    connectSourcePhoneNumber String
    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.
    connectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    Whether answering machine detection has been enabled.
    connectQueueArn string
    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.
    connectSourcePhoneNumber string
    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.
    connect_contact_flow_arn str
    The identifier of the contact flow for the outbound call.
    answer_machine_detection_config CampaignAnswerMachineDetectionConfig
    Whether answering machine detection has been enabled.
    connect_queue_arn str
    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.
    connect_source_phone_number str
    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.
    connectContactFlowArn String
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig Property Map
    Whether answering machine detection has been enabled.
    connectQueueArn String
    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.
    connectSourcePhoneNumber String
    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.

    CampaignPredictiveDialerConfig

    BandwidthAllocation double
    The bandwidth allocation of a queue resource.
    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    BandwidthAllocation float64
    The bandwidth allocation of a queue resource.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Double
    The bandwidth allocation of a queue resource.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation number
    The bandwidth allocation of a queue resource.
    dialingCapacity number
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidth_allocation float
    The bandwidth allocation of a queue resource.
    dialing_capacity float
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Number
    The bandwidth allocation of a queue resource.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    CampaignProgressiveDialerConfig

    BandwidthAllocation double
    The bandwidth allocation of a queue resource.
    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    BandwidthAllocation float64
    The bandwidth allocation of a queue resource.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Double
    The bandwidth allocation of a queue resource.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation number
    The bandwidth allocation of a queue resource.
    dialingCapacity number
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidth_allocation float
    The bandwidth allocation of a queue resource.
    dialing_capacity float
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Number
    The bandwidth allocation of a queue resource.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native