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-contact-lens ]

list-realtime-contact-analysis-segments

Description

Provides a list of analysis segments for a real-time analysis session.

See also: AWS API Documentation

Synopsis

  list-realtime-contact-analysis-segments
--instance-id <value>
--contact-id <value>
[--max-results <value>]
[--next-token <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

--instance-id (string)

The identifier of the Amazon Connect instance.

--contact-id (string)

The identifier of the contact.

--max-results (integer)

The maximimum number of results to return per page.

--next-token (string)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

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

Segments -> (list)

An analyzed transcript or category.

(structure)

An analyzed segment for a real-time analysis session.

Transcript -> (structure)

The analyzed transcript.

Id -> (string)

The identifier of the transcript.

ParticipantId -> (string)

The identifier of the participant.

ParticipantRole -> (string)

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

Content -> (string)

The content of the transcript.

BeginOffsetMillis -> (integer)

The beginning offset in the contact for this transcript.

EndOffsetMillis -> (integer)

The end offset in the contact for this transcript.

Sentiment -> (string)

The sentiment of the detected for this piece of transcript.

IssuesDetected -> (list)

List of positions where issues were detected on the transcript.

(structure)

Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.

CharacterOffsets -> (structure)

The offset for when the issue was detected in the segment.

BeginOffsetChar -> (integer)

The beginning of the issue.

EndOffsetChar -> (integer)

The end of the issue.

Categories -> (structure)

The matched category rules.

MatchedCategories -> (list)

The category rules that have been matched in the analyzed segment.

(string)

MatchedDetails -> (map)

The category rule that was matched and when it occurred in the transcript.

key -> (string)

value -> (structure)

Provides information about the category rule that was matched.

PointsOfInterest -> (list)

The section of audio where the category rule was detected.

(structure)

The section of the contact audio where that category rule was detected.

BeginOffsetMillis -> (integer)

The beginning offset in milliseconds where the category rule was detected.

EndOffsetMillis -> (integer)

The ending offset in milliseconds where the category rule was detected.

NextToken -> (string)

If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible scenarios:

  • There are more segments so another call is required to get them.
  • There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.

If response does not include nextToken , the analysis is completed (successfully or failed) and there are no more segments to retrieve.