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

batch-put-contact

Description

Note

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

See also: AWS API Documentation

Synopsis

  batch-put-contact
[--client-token <value>]
--instance-id <value>
--contact-data-request-list <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

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

--contact-data-request-list (list)

List of individual contact requests.

(structure)

Request object with information to create a contact.

SystemEndpoint -> (structure)

Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.

Type -> (string)

Type of the endpoint.

Address -> (string)

Address of the endpoint.

CustomerEndpoint -> (structure)

Endpoint of the customer for which contact will be initiated.

Type -> (string)

Type of the endpoint.

Address -> (string)

Address of the endpoint.

RequestIdentifier -> (string)

Identifier to uniquely identify individual requests in the batch.

QueueId -> (string)

The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.

Attributes -> (map)

List of attributes to be stored in a contact.

key -> (string)

value -> (string)

Campaign -> (structure)

Structure to store information associated with a campaign.

CampaignId -> (string)

A unique identifier for a campaign.

Shorthand Syntax:

SystemEndpoint={Type=string,Address=string},CustomerEndpoint={Type=string,Address=string},RequestIdentifier=string,QueueId=string,Attributes={KeyName1=string,KeyName2=string},Campaign={CampaignId=string} ...

JSON Syntax:

[
  {
    "SystemEndpoint": {
      "Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
      "Address": "string"
    },
    "CustomerEndpoint": {
      "Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
      "Address": "string"
    },
    "RequestIdentifier": "string",
    "QueueId": "string",
    "Attributes": {"string": "string"
      ...},
    "Campaign": {
      "CampaignId": "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

SuccessfulRequestList -> (list)

List of requests for which contact was successfully created.

(structure)

Request for which contact was successfully created.

RequestIdentifier -> (string)

Request identifier provided in the API call in the ContactDataRequest to create a contact.

ContactId -> (string)

The contactId of the contact that was created successfully.

FailedRequestList -> (list)

List of requests for which contact creation failed.

(structure)

Request for which contact failed to be generated.

RequestIdentifier -> (string)

Request identifier provided in the API call in the ContactDataRequest to create a contact.

FailureReasonCode -> (string)

Reason code for the failure.

FailureReasonMessage -> (string)

Why the request to create a contact failed.