[ aws . connectcampaigns ]

create-campaign

Description

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-campaign
--connect-instance-id <value>
--dialer-config <value>
--name <value>
--outbound-call-config <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--connect-instance-id (string)

Amazon Connect Instance Id

--dialer-config (structure)

The possible types of dialer config parameters

predictiveDialerConfig -> (structure)

Predictive Dialer config

bandwidthAllocation -> (double)

The bandwidth allocation of a queue resource.

progressiveDialerConfig -> (structure)

Progressive Dialer config

bandwidthAllocation -> (double)

The bandwidth allocation of a queue resource.

Shorthand Syntax:

predictiveDialerConfig={bandwidthAllocation=double},progressiveDialerConfig={bandwidthAllocation=double}

JSON Syntax:

{
  "predictiveDialerConfig": {
    "bandwidthAllocation": double
  },
  "progressiveDialerConfig": {
    "bandwidthAllocation": double
  }
}

--name (string)

The name of an Amazon Connect Campaign name.

--outbound-call-config (structure)

The configuration used for outbound calls.

answerMachineDetectionConfig -> (structure)

Answering Machine Detection config

enableAnswerMachineDetection -> (boolean)

Enable or disable answering machine detection

connectContactFlowId -> (string)

The identifier of the contact flow for the outbound call.

connectQueueId -> (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.

Shorthand Syntax:

answerMachineDetectionConfig={enableAnswerMachineDetection=boolean},connectContactFlowId=string,connectQueueId=string,connectSourcePhoneNumber=string

JSON Syntax:

{
  "answerMachineDetectionConfig": {
    "enableAnswerMachineDetection": true|false
  },
  "connectContactFlowId": "string",
  "connectQueueId": "string",
  "connectSourcePhoneNumber": "string"
}

--tags (map)

Tag map with key and value.

key -> (string)

Tag key.

value -> (string)

Tag value.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

arn -> (string)

The resource name of an Amazon Connect campaign.

id -> (string)

Identifier representing a Campaign

tags -> (map)

Tag map with key and value.

key -> (string)

Tag key.

value -> (string)

Tag value.