AWS CLI Command Reference

[ aws . connect ]

start-contact-conversational-analytics-job

Description

Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.

Warning

A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI.

Note

For example, you can call CreateContact , then CreateAttachedFile , then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.

See also: AWS API Documentation

Synopsis

  start-contact-conversational-analytics-job
--instance-id <value>
--contact-id <value>
--analytics-modes <value>
--analytics-configuration <value>
[--client-token <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

--contact-id (string) [required]

The identifier of the contact in this instance of Connect Customer.

Constraints:

  • min: 1
  • max: 256

--analytics-modes (list) [required]

The analytics modes to run for the contact. Valid values: PostContact .

(string)

Possible values:

  • PostContact
  • RealTime
  • ContactLens
  • AutomatedInteraction

Syntax:

"string" "string" ...

--analytics-configuration (structure) [required]

The configuration for the conversational analytics job.

LanguageConfiguration -> (structure) [required]

The language configuration for conversational analytics.

LanguageLocale -> (string)

The language locale setting for conversational analytics.

RedactionConfiguration -> (structure) [required]

The redaction configuration for conversational analytics.

Behavior -> (string) [required]

Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable .

Possible values:

  • Enable
  • Disable

Policy -> (string) [required]

The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal .

Possible values:

  • None
  • RedactedOnly
  • RedactedAndOriginal

Entities -> (list)

The list of PII entity types to redact from the transcript (for example, NAME , ADDRESS , CREDIT_DEBIT_NUMBER ).

(string)

Constraints:

  • min: 1

MaskMode -> (string)

The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).

Possible values:

  • PII
  • EntityType

SentimentConfiguration -> (structure) [required]

The sentiment configuration for conversational analytics.

Behavior -> (string) [required]

Controls whether sentiment analysis is applied to the analytics output. Valid values: Enable | Disable .

Possible values:

  • Enable
  • Disable

SummaryConfiguration -> (structure) [required]

The summary configuration for conversational analytics.

SummaryModes -> (list) [required]

The summary modes that determine what type of summarization is generated. Valid values: PostContact | AutomatedInteraction | ContactChain .

Constraints:

  • min: 0
  • max: 2

(string)

Possible values:

  • PostContact
  • AutomatedInteraction
  • ContactChain

RulesConfiguration -> (structure) [required]

The rules configuration for conversational analytics.

Behavior -> (string)

Controls whether Contact Lens rules are evaluated for the contact. Valid values: Enable | Disable .

Possible values:

  • Enable
  • Disable

Shorthand Syntax:

LanguageConfiguration={LanguageLocale=string},RedactionConfiguration={Behavior=string,Policy=string,Entities=[string,string],MaskMode=string},SentimentConfiguration={Behavior=string},SummaryConfiguration={SummaryModes=[string,string]},RulesConfiguration={Behavior=string}

JSON Syntax:

{
  "LanguageConfiguration": {
    "LanguageLocale": "string"
  },
  "RedactionConfiguration": {
    "Behavior": "Enable"|"Disable",
    "Policy": "None"|"RedactedOnly"|"RedactedAndOriginal",
    "Entities": ["string", ...],
    "MaskMode": "PII"|"EntityType"
  },
  "SentimentConfiguration": {
    "Behavior": "Enable"|"Disable"
  },
  "SummaryConfiguration": {
    "SummaryModes": ["PostContact"|"AutomatedInteraction"|"ContactChain", ...]
  },
  "RulesConfiguration": {
    "Behavior": "Enable"|"Disable"
  }
}

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

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

InstanceId -> (string)

The identifier of the Connect Customer instance.

Constraints:

  • min: 1
  • max: 100

ContactId -> (string)

The identifier of the contact.

Constraints:

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