Table Of Contents

Feedback

User Guide

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

[ aws . transcribe ]

start-transcription-job

Description

Starts an asynchronous job to transcribe speech to text.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-transcription-job
--transcription-job-name <value>
--language-code <value>
[--media-sample-rate-hertz <value>]
--media-format <value>
--media <value>
[--output-bucket-name <value>]
[--settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--transcription-job-name (string)

The name of the job. You can't use the strings "." or ".." in the job name. The name must be unique within an AWS account.

--language-code (string)

The language code for the language used in the input media file.

Possible values:

  • en-US
  • es-US

--media-sample-rate-hertz (integer)

The sample rate, in Hertz, of the audio track in the input media file.

--media-format (string)

The format of the input media file.

Possible values:

  • mp3
  • mp4
  • wav
  • flac

--media (structure)

An object that describes the input media for a transcription job.

Shorthand Syntax:

MediaFileUri=string

JSON Syntax:

{
  "MediaFileUri": "string"
}

--output-bucket-name (string)

The location where the transcription is stored.

If you set the output-bucket-name , Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the get-transcription-job operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles .

If you don't set the output-bucket-name , Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

--settings (structure)

A settings object that provides optional settings for a transcription job.

Shorthand Syntax:

VocabularyName=string,ShowSpeakerLabels=boolean,MaxSpeakerLabels=integer

JSON Syntax:

{
  "VocabularyName": "string",
  "ShowSpeakerLabels": true|false,
  "MaxSpeakerLabels": integer
}

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

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

TranscriptionJob -> (structure)

An object containing details of the asynchronous transcription job.

TranscriptionJobName -> (string)

The name of the transcription job.

TranscriptionJobStatus -> (string)

The status of the transcription job.

LanguageCode -> (string)

The language code for the input speech.

MediaSampleRateHertz -> (integer)

The sample rate, in Hertz, of the audio track in the input media file.

MediaFormat -> (string)

The format of the input media file.

Media -> (structure)

An object that describes the input media for the transcription job.

MediaFileUri -> (string)

The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://aws-region.amazonaws.com/bucket-name/keyprefix/objectkey

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4

https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .

Transcript -> (structure)

An object that describes the output of the transcription job.

TranscriptFileUri -> (string)

The location where the transcription is stored.

Use this URI to access the transcription. If you specified an S3 bucket in the output-bucket-name field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.

CreationTime -> (timestamp)

A timestamp that shows when the job was created.

CompletionTime -> (timestamp)

A timestamp that shows when the job was completed.

FailureReason -> (string)

If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.

Settings -> (structure)

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

VocabularyName -> (string)

The name of a vocabulary to use when processing the transcription job.

ShowSpeakerLabels -> (boolean)

Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

MaxSpeakerLabels -> (integer)

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.