AWS Native v0.64.0, Jun 2 23

aws-native.connectcampaigns.getCampaign

Explore with Pulumi AI

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
Name string: Amazon Connect Campaign Name
OutboundCallConfig Pulumi.AwsNative.ConnectCampaigns.Outputs.CampaignOutboundCallConfig
Tags List<Pulumi.AwsNative.ConnectCampaigns.Outputs.CampaignTag>: One or more tags.

Arn string: Amazon Connect Campaign Arn
DialerConfig CampaignDialerConfig
Name string: Amazon Connect Campaign Name
OutboundCallConfig CampaignOutboundCallConfig
Tags []CampaignTag: One or more tags.

arn String: Amazon Connect Campaign Arn
dialerConfig CampaignDialerConfig
name String: Amazon Connect Campaign Name
outboundCallConfig CampaignOutboundCallConfig
tags List<CampaignTag>: One or more tags.

arn string: Amazon Connect Campaign Arn
dialerConfig CampaignDialerConfig
name string: Amazon Connect Campaign Name
outboundCallConfig CampaignOutboundCallConfig
tags CampaignTag[]: One or more tags.

arn str: Amazon Connect Campaign Arn
dialer_config CampaignDialerConfig
name str: Amazon Connect Campaign Name
outbound_call_config CampaignOutboundCallConfig
tags Sequence[CampaignTag]: One or more tags.

arn String: Amazon Connect Campaign Arn
dialerConfig Property Map
name String: Amazon Connect Campaign Name
outboundCallConfig Property Map
tags List<Property Map>: One or more tags.

Supporting Types

CampaignAnswerMachineDetectionConfig

EnableAnswerMachineDetection bool: Flag to decided whether outbound calls should have answering machine detection enabled or not

EnableAnswerMachineDetection bool: Flag to decided whether outbound calls should have answering machine detection enabled or not

enableAnswerMachineDetection Boolean: Flag to decided whether outbound calls should have answering machine detection enabled or not

enableAnswerMachineDetection boolean: Flag to decided whether outbound calls should have answering machine detection enabled or not

enable_answer_machine_detection bool: Flag to decided whether outbound calls should have answering machine detection enabled or not

enableAnswerMachineDetection Boolean: Flag to decided whether outbound calls should have answering machine detection enabled or not

CampaignDialerConfig

PredictiveDialerConfig Pulumi.AwsNative.ConnectCampaigns.Inputs.CampaignPredictiveDialerConfig
ProgressiveDialerConfig Pulumi.AwsNative.ConnectCampaigns.Inputs.CampaignProgressiveDialerConfig

PredictiveDialerConfig CampaignPredictiveDialerConfig
ProgressiveDialerConfig CampaignProgressiveDialerConfig

predictiveDialerConfig CampaignPredictiveDialerConfig
progressiveDialerConfig CampaignProgressiveDialerConfig

predictiveDialerConfig CampaignPredictiveDialerConfig
progressiveDialerConfig CampaignProgressiveDialerConfig

predictive_dialer_config CampaignPredictiveDialerConfig
progressive_dialer_config CampaignProgressiveDialerConfig

predictiveDialerConfig Property Map
progressiveDialerConfig Property Map

CampaignOutboundCallConfig

ConnectContactFlowArn string: The identifier of the contact flow for the outbound call.
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.
AnswerMachineDetectionConfig Pulumi.AwsNative.ConnectCampaigns.Inputs.CampaignAnswerMachineDetectionConfig
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.
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.
AnswerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
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.
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.
answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
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.
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.
answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
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.
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.
answer_machine_detection_config CampaignAnswerMachineDetectionConfig
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.
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.
answerMachineDetectionConfig Property Map
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.

BandwidthAllocation float64: The bandwidth allocation of a queue resource.

bandwidthAllocation Double: The bandwidth allocation of a queue resource.

bandwidthAllocation number: The bandwidth allocation of a queue resource.

bandwidth_allocation float: The bandwidth allocation of a queue resource.

bandwidthAllocation Number: The bandwidth allocation of a queue resource.

CampaignProgressiveDialerConfig

BandwidthAllocation double: The bandwidth allocation of a queue resource.

BandwidthAllocation float64: The bandwidth allocation of a queue resource.

bandwidthAllocation Double: The bandwidth allocation of a queue resource.

bandwidthAllocation number: The bandwidth allocation of a queue resource.

bandwidth_allocation float: The bandwidth allocation of a queue resource.

bandwidthAllocation Number: The bandwidth allocation of a queue resource.

CampaignTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that's 1 to 256 characters in length.

Package Details

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