Table Of Contents


User Guide

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

[ aws . transcribe ]



Lists transcription jobs with the specified status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--status <value>]
[--job-name-contains <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--status (string)

When specified, returns only transcription jobs with the specified status.

Possible values:


--job-name-contains (string)

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

--next-token (string)

If the result of the previous request to list-transcription-jobs was truncated, include the next-token to fetch the next set of jobs.

--max-results (integer)

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual 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.

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


Status -> (string)

The requested status of the jobs returned.

NextToken -> (string)

The list-transcription-jobs operation returns a page of jobs at a time. The maximum size of the page is set by the max-results parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the list-transcription-jobs operation to return in the next page of jobs.

TranscriptionJobSummaries -> (list)

A list of objects containing summary information for a transcription job.


Provides a summary of information about a transcription job.

TranscriptionJobName -> (string)

The name of the transcription job.

CreationTime -> (timestamp)

A timestamp that shows when the job was created.

CompletionTime -> (timestamp)

A timestamp that shows when the job was completed.

LanguageCode -> (string)

The language code for the input speech.

TranscriptionJobStatus -> (string)

The status of the transcription job. When the status is COMPLETED , use the get-transcription-job operation to get the results of the transcription.

FailureReason -> (string)

If the status field is FAILED , a description of the error.

OutputLocationType -> (string)

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the start-transcription-job operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the get-transcription-job response's TranscriptFileUri field.