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 ]

start-contact-recording

Description

Starts recording the contact:

  • If the API is called before the agent joins the call, recording starts when the agent joins the call.
  • If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-contact-recording
--instance-id <value>
--contact-id <value>
--initial-contact-id <value>
--voice-recording-configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--contact-id (string)

The identifier of the contact.

--initial-contact-id (string)

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

--voice-recording-configuration (structure)

The person being recorded.

VoiceRecordingTrack -> (string)

Identifies which track is being recorded.

Shorthand Syntax:

VoiceRecordingTrack=string

JSON Syntax:

{
  "VoiceRecordingTrack": "FROM_AGENT"|"TO_AGENT"|"ALL"
}

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

Output

None