AWS CLI Command Reference

[ aws . connectcampaigns ]

create-campaign

Description

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

See also: AWS API Documentation

Synopsis

  create-campaign
--name <value>
--connect-instance-id <value>
--dialer-config <value>
--outbound-call-config <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--name (string)

The name of an Amazon Connect Campaign name.

--connect-instance-id (string)

Amazon Connect Instance Id

--dialer-config (tagged union structure)

The possible types of dialer config parameters

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: progressiveDialerConfig, predictiveDialerConfig, agentlessDialerConfig.

progressiveDialerConfig -> (structure)

Progressive Dialer config

bandwidthAllocation -> (double)

The bandwidth allocation of a queue resource.

dialingCapacity -> (double)

Allocates dialing capacity for this campaign between multiple active campaigns

predictiveDialerConfig -> (structure)

Predictive Dialer config

bandwidthAllocation -> (double)

The bandwidth allocation of a queue resource.

dialingCapacity -> (double)

Allocates dialing capacity for this campaign between multiple active campaigns

agentlessDialerConfig -> (structure)

Agentless Dialer config

dialingCapacity -> (double)

Allocates dialing capacity for this campaign between multiple active campaigns

Shorthand Syntax:

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

JSON Syntax:

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

--outbound-call-config (structure)

The configuration used for outbound calls.

connectContactFlowId -> (string)

The identifier of the contact flow for the outbound call.

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.

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.

answerMachineDetectionConfig -> (structure)

Answering Machine Detection config

enableAnswerMachineDetection -> (boolean)

Enable or disable answering machine detection

awaitAnswerMachinePrompt -> (boolean)

Enable or disable await answer machine prompt

Shorthand Syntax:

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

JSON Syntax:

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

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

id -> (string)

Identifier representing a Campaign

arn -> (string)

The resource name of an Amazon Connect campaign.

tags -> (map)

Tag map with key and value.

key -> (string)

Tag key.

value -> (string)

Tag value.
© Copyright 2018, Amazon Web Services. Created using Sphinx.