Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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



Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--contact-id <value>]
[--max-results <value>]
[--next-token <value>]
[--scan-direction <value>]
[--sort-order <value>]
[--start-position <value>]
--connection-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--contact-id (string)

The contactId from the current contact chain for which transcript is needed.

--max-results (integer)

The maximum number of results to return in the page. Default: 10.

--next-token (string)

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

--scan-direction (string)

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Possible values:


--sort-order (string)

The sort order for the records. Default: DESCENDING.

Possible values:


--start-position (structure)

A filtering option for where to start.

Shorthand Syntax:


JSON Syntax:

  "Id": "string",
  "AbsoluteTime": "string",
  "MostRecent": integer

--connection-token (string)

The authentication token associated with the participant's connection.

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

See 'aws help' for descriptions of global parameters.


InitialContactId -> (string)

The initial contact ID for the contact.

Transcript -> (list)

The list of messages in the session.


An item - message or event - that has been sent.

AbsoluteTime -> (string)

The time when the message or event was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Content -> (string)

The content of the message or event.

ContentType -> (string)

The type of content of the item.

Id -> (string)

The ID of the item.

Type -> (string)

Type of the item: message or event.

ParticipantId -> (string)

The ID of the sender in the session.

DisplayName -> (string)

The chat display name of the sender.

ParticipantRole -> (string)

The role of the sender. For example, is it a customer, agent, or system.

NextToken -> (string)

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.