AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getCampaign

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 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

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.

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.

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.

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.

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.

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.

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.

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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0