AWS CLI Command Reference

[ aws . connect ]

start-assistant-contact

Description

Starts a chat contact with an AI agent.

Use the returned ParticipantToken to call the CreateParticipantConnection API.

For more information about chat, see the following topics in the Connect Customer Administrator Guide :

See also: AWS API Documentation

Synopsis

  start-assistant-contact
--instance-id <value>
--ai-agent <value>
--participant-details <value>
[--initial-message <value>]
[--attributes <value>]
[--client-token <value>]
[--persistent-chat <value>]
[--related-contact-id <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]
[--cli-error-format <value>]

Options

--instance-id (string) [required]

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

Constraints:

  • min: 1
  • max: 100

--ai-agent (structure) [required]

The AI agent that participates in the contact.

AiAgentId -> (string) [required]

The identifier of the AI agent that participates in the contact.

Constraints:

  • min: 0
  • max: 128

Shorthand Syntax:

AiAgentId=string

JSON Syntax:

{
  "AiAgentId": "string"
}

--participant-details (structure) [required]

The display name and other details that identify the chat participant.

DisplayName -> (string) [required]

Display name of the participant.

Constraints:

  • min: 1
  • max: 256

Shorthand Syntax:

DisplayName=string

JSON Syntax:

{
  "DisplayName": "string"
}

--initial-message (structure)

The initial message to send to the newly created chat.

ContentType -> (string) [required]

The type of the content. Supported types are text/plain , text/markdown , application/json , and application/vnd.amazonaws.connect.message.interactive.response .

Constraints:

  • min: 1
  • max: 100

Content -> (string) [required]

The content of the chat message. Maximum of 16,384 bytes for all content types (text/plain , text/markdown , application/json , and application/vnd.amazonaws.connect.message.interactive.response ).

Some messaging channels enforce lower limits. For channel-specific message size limits, see Chat message size limits by channel in the Amazon Connect Customer Administrator Guide .

Constraints:

  • min: 1
  • max: 16384

Shorthand Syntax:

ContentType=string,Content=string

JSON Syntax:

{
  "ContentType": "string",
  "Content": "string"
}

--attributes (map)

A map of key-value pairs to associate with the contact. Amazon Connect makes these attributes available to flows as standard contact attributes.

You can provide up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can contain only alphanumeric characters, dashes, and underscores.

key -> (string)

Constraints:

  • min: 1
  • max: 32767

value -> (string)

Constraints:

  • min: 0
  • max: 32767

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

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

Constraints:

  • max: 500

--persistent-chat (structure)

The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat .

RehydrationType -> (string)

The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.

  • ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Connect Customer determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
  • FROM_SEGMENT : Rehydrates a chat from the past chat contact that is specified in the sourceContactId field.

The actual contactId used for rehydration is provided in the response of this API.

Possible values:

  • ENTIRE_PAST_SESSION
  • FROM_SEGMENT

SourceContactId -> (string)

The contactId from which a persistent chat session must be started.

Constraints:

  • min: 1
  • max: 256

Shorthand Syntax:

RehydrationType=string,SourceContactId=string

JSON Syntax:

{
  "RehydrationType": "ENTIRE_PAST_SESSION"|"FROM_SEGMENT",
  "SourceContactId": "string"
}

--related-contact-id (string)

The identifier of an Connect Customer contact related to the new assistant contact.

Note

You cannot provide both RelatedContactId and PersistentChat .

Constraints:

  • min: 1
  • max: 256

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

ContactId -> (string)

The identifier of the contact within the Connect Customer instance.

Constraints:

  • min: 1
  • max: 256

ParticipantId -> (string)

The identifier of the chat participant. The participant identifier remains the same throughout the chat lifecycle.

Constraints:

  • min: 1
  • max: 256

ParticipantToken -> (string)

The token that the chat participant uses to call the CreateParticipantConnection API. The token remains valid for the lifetime of the chat participant.

Constraints:

  • min: 1
  • max: 1000

ContinuedFromContactId -> (string)

For a persistent chat, the identifier of the contact from which the chat continues. Amazon Connect returns this field only for persistent chats.

Constraints:

  • min: 1
  • max: 256
© Copyright 2026, Amazon Web Services. Created using Sphinx.