AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connectcampaignsv2 ]

put-outbound-request-batch

Description

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

See also: AWS API Documentation

Synopsis

  put-outbound-request-batch
--id <value>
--outbound-requests <value>
[--cli-input-json <value>]
[--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>]

Options

--id (string)

Identifier representing a Campaign

--outbound-requests (list)

A list of outbound requests.

(structure)

An outbound request for a campaign.

clientToken -> (string)

Client provided parameter used for idempotency. Its value must be unique for each request.

expirationTime -> (timestamp)

Timestamp with no UTC offset or timezone

channelSubtypeParameters -> (tagged union structure)

ChannelSubtypeParameters for an outbound request

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: telephony, sms, email.

telephony -> (structure)

Parameters for the Telephony Channel Subtype

destinationPhoneNumber -> (string)

The phone number of the customer, in E.164 format.

attributes -> (map)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

key -> (string)

The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.

value -> (string)

The value of the attribute.

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.

answerMachineDetectionConfig -> (structure)

Answering Machine Detection config

enableAnswerMachineDetection -> (boolean)

Enable or disable answering machine detection

awaitAnswerMachinePrompt -> (boolean)

Enable or disable await answer machine prompt

sms -> (structure)

Parameters for the SMS Channel Subtype

destinationPhoneNumber -> (string)

The phone number of the customer, in E.164 format.

connectSourcePhoneNumberArn -> (string)

Amazon Resource Names(ARN)

templateArn -> (string)

Amazon Resource Names(ARN)

templateParameters -> (map)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

key -> (string)

The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.

value -> (string)

The value of the attribute.

email -> (structure)

Parameters for the Email Channel Subtype

destinationEmailAddress -> (string)

Source/Destination Email address used for Email messages

connectSourceEmailAddress -> (string)

Source/Destination Email address used for Email messages

templateArn -> (string)

Amazon Resource Names(ARN)

templateParameters -> (map)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

key -> (string)

The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.

value -> (string)

The value of the attribute.

JSON Syntax:

[
  {
    "clientToken": "string",
    "expirationTime": timestamp,
    "channelSubtypeParameters": {
      "telephony": {
        "destinationPhoneNumber": "string",
        "attributes": {"string": "string"
          ...},
        "connectSourcePhoneNumber": "string",
        "answerMachineDetectionConfig": {
          "enableAnswerMachineDetection": true|false,
          "awaitAnswerMachinePrompt": true|false
        }
      },
      "sms": {
        "destinationPhoneNumber": "string",
        "connectSourcePhoneNumberArn": "string",
        "templateArn": "string",
        "templateParameters": {"string": "string"
          ...}
      },
      "email": {
        "destinationEmailAddress": "string",
        "connectSourceEmailAddress": "string",
        "templateArn": "string",
        "templateParameters": {"string": "string"
          ...}
      }
    }
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

successfulRequests -> (list)

A list of successful requests identified by the unique client token.

(structure)

A successful request identified by the unique client token.

clientToken -> (string)

Client provided parameter used for idempotency. Its value must be unique for each request.

id -> (string)

Identifier representing a Dial request

failedRequests -> (list)

A list of failed requests.

(structure)

A failed request identified by the unique client token.

clientToken -> (string)

Client provided parameter used for idempotency. Its value must be unique for each request.

id -> (string)

Identifier representing a Dial request

failureCode -> (string)

A predefined code indicating the error that caused the failure.