Table Of Contents

Feedback

User Guide

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

[ aws . transcribe ]

list-transcription-jobs

Description

Lists transcription jobs with the specified status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-transcription-jobs
--status <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--status (string)

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

Possible values:

  • IN_PROGRESS
  • FAILED
  • COMPLETED

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

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

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

(structure)

Provides a summary of information about a transcription job.

TranscriptionJobName -> (string)

The name assigned to the transcription job when it was created.

CreationTime -> (timestamp)

Timestamp of the date and time that the job was created.

CompletionTime -> (timestamp)

Timestamp of the date and time that the job 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 , this field contains a description of the error.